WWGraphQLEndpoint (Java SDK API Client 0.9.0-SNAPSHOT API)

java.lang.Object
- org.opencode4workspace.endpoints.AbstractWWGraphQLEndpoint
- - org.opencode4workspace.endpoints.WWGraphQLEndpoint

All Implemented Interfaces:: IWWGraphQLEndpoint

public class WWGraphQLEndpoint
extends AbstractWWGraphQLEndpoint

Constructor Summary

Constructors
Constructor and Description

WWGraphQLEndpoint(IWWClient client)

Constructors
Constructor and Description
`WWGraphQLEndpoint(IWWClient client)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArrayList<String>`	`addSpaceMembers(String id, List<SpaceMembersAddDataSenderBuilder.SpaceMemberObject> members)` Add members to a Space, returning List of members updated
`Space`	`createSpace(String title, List<String> members)` Create a space with a title and list of members
`Space`	`createSpaceWithMutation(SpaceCreateGraphQLMutation mutationObject)` Create a space with a SpaceCreateGraphQLMutation object
`boolean`	`deleteSpace(String id)` Delete a space for a given ID
`Conversation`	`getConversation(String conversationId)` Get basic data Conversation object for relevant Conversation
`Conversation`	`getConversationWithQuery(ConversationGraphQLQuery query)` Get Conversation object with query
`ConversationWrapper`	`getConversationWrapperWithQuery(ConversationGraphQLQuery query)` Get ConversationWrapper object with query.
`Person`	`getMe()` Simplified access method, to load GraphQL query for getting Me object
`List<Mentioned>`	`getMentioned()` Get Mentioned query with first 10 mentions.
`List<Mentioned>`	`getMentioned(MentionedGraphQLQuery query)` Get Mentioned query with passed query.
`MentionedContainer`	`getMentionedContainerWithQuery(MentionedGraphQLQuery query)`
`Message`	`getMessageById(String messageId)` Get a Message by using a messageId
`Message`	`getMessageWithQuery(MessageGraphQLQuery query)` Get a Message by using a messageId
`List<Person>`	`getPeople(List<String> ids)` Gets People matching the passed ids
`List<Person>`	`getPeopleByName(String name)` Gets People matching the single word name passed.
`MembersContainer`	`getPeopleContainerWithQuery(PeopleGraphQLQuery query)`
`List<Person>`	`getPeopleWithQuery(PeopleGraphQLQuery query)` Get People with query.
`Person`	`getPersonByEmail(String personEmail)` Simplified access method, to load GraphQL query for getting Person by email or "me" if personId is blank
`Person`	`getPersonById(String personId)` Simplified access method, to load GraphQL query for getting Person by ID or "me" if personId is blank
`Person`	`getPersonWithQuery(PersonGraphQLQuery query)` Get Person Object with GraphQL Query
`Space`	`getSpaceById(String spaceId)` Get a Space by using a spaceId
`List<Person>`	`getSpaceMembers(String spaceId)` Get basic data for Space Members for relevant Sapce
`List<Person>`	`getSpaceMembersWithQuery(SpaceMembersGraphQLQuery query)` Get Space Members with query
`List<? extends Space>`	`getSpaces()` Simplified access method, to load GraphQL query for getting spaces, execute the request, and parse the results.
`SpacesContainer`	`getSpacesContainerWithQuery(SpacesGraphQLQuery query)` Get the SpacesContainer, including PageInfo object
`List<? extends Space>`	`getSpacesWithQuery(SpacesGraphQLQuery query)` getSpaces by using a SpacesGraphQLQuery.
`Space`	`getSpaceWithQuery(SpaceGraphQLQuery query)` getSpace by using a SpaceGraphQLQuery
`ArrayList<String>`	`removeSpaceMembers(String id, List<String> members)` Remove members of a Space, returning List of members updated and the
`ArrayList<String>`	`updateSpaceMembers(String id, List<String> members, SpaceUpdateGraphQLMutation.UpdateSpaceMemberOperation addOrRemove)` Update the members of a Space, returning List of members updated
`UpdateSpaceContainer`	`updateSpaceMembersAndTitle(String id, String title, List<String> members, SpaceUpdateGraphQLMutation.UpdateSpaceMemberOperation addOrRemove)` Update the members of a Space and its title, returning a UpdateSpaceContainer containing an Array of members updated and Space object with the new title
`Space`	`updateSpaceTitle(String id, String newTitle)` Change the title of a Space, returning Space object with updated title
`UpdateSpaceContainer`	`updateSpaceWithMutation(SpaceUpdateGraphQLMutation mutationObject)` Updates a Space with a query, returning a UpdateSpaceContainer containing an Array of members updated and Space object with the new title

Methods inherited from class org.opencode4workspace.endpoints.AbstractWWGraphQLEndpoint
executeRequest, getAliasedChildren, getClient, getProfileDump, getRequest, getResultContainer, getResultContent, parseResultContainer, setProfileDump, setRequest, setResultContainer, setResultContent

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WWGraphQLEndpoint
```
public WWGraphQLEndpoint(IWWClient client)
```
    Parameters:
    
    client - WWClient containing authentication details and token
    
    Since:
    
    0.5.0
- Method Detail
  - getSpaces
```
public List<? extends Space> getSpaces()
                                throws WWException
```
    Simplified access method, to load GraphQL query for getting spaces, execute the request, and parse the results. Note: this doesn't have access to PageInfo class with startCursor / endCursor and whether or not there are additional / previous pages.
    
    Returns:
    
    List of Space details
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpacesWithQuery
```
public List<? extends Space> getSpacesWithQuery(SpacesGraphQLQuery query)
                                         throws WWException
```
    getSpaces by using a SpacesGraphQLQuery. Note: this doesn't have access to PageInfo class with startCursor / endCursor and whether or not there are additional / previous pages.
    
    Parameters:
    
    query - GraphQLQuery for the call
    
    Returns:
    
    List of Space details
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpacesContainerWithQuery
```
public SpacesContainer getSpacesContainerWithQuery(SpacesGraphQLQuery query)
                                            throws WWException
```
    Get the SpacesContainer, including PageInfo object
    
    Parameters:
    
    query - GraphQLQuery for the call
    
    Returns:
    
    SpacesContainer containing List extending Space and PageInfo object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - createSpace
```
public Space createSpace(String title,
                         List<String> members)
                  throws WWException
```
    Create a space with a title and list of members
    
    Parameters:
    
    title - String title for the Space
    
    members - List of member IDs to be granted access to the Space
    
    Returns:
    
    Space containing the ID of the newly-created Space
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.6.0
  - createSpaceWithMutation
```
public Space createSpaceWithMutation(SpaceCreateGraphQLMutation mutationObject)
                              throws WWException
```
    Create a space with a SpaceCreateGraphQLMutation object
    
    Parameters:
    
    mutationObject - SpaceCreateGraphQLMutation containing the details to create
    
    Returns:
    
    Space containing the ID of the newly-created Space
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.6.0
  - deleteSpace
```
public boolean deleteSpace(String id)
                    throws WWException
```
    Delete a space for a given ID
    
    Parameters:
    
    id - String id of the space to delete
    
    Returns:
    
    boolean whether or not the deletion attempt was successful
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.6.0
  - updateSpaceTitle
```
public Space updateSpaceTitle(String id,
                              String newTitle)
                       throws WWException
```
    Change the title of a Space, returning Space object with updated title
    
    Parameters:
    
    id - String id of the space to update
    
    newTitle - String new title for the space
    
    Returns:
    
    Space updated
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.6.0
  - updateSpaceMembers
```
public ArrayList<String> updateSpaceMembers(String id,
                                            List<String> members,
                                            SpaceUpdateGraphQLMutation.UpdateSpaceMemberOperation addOrRemove)
                                     throws WWException
```
    Update the members of a Space, returning List of members updated
    
    Parameters:
    
    id - String id of the space to update
    
    members - List of member IDs to add / remove as members
    
    addOrRemove - boolean whether members should be added to the Space or removed
    
    Returns:
    
    ArrayList of member IDs updated
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.6.0
  - updateSpaceMembersAndTitle
```
public UpdateSpaceContainer updateSpaceMembersAndTitle(String id,
                                                       String title,
                                                       List<String> members,
                                                       SpaceUpdateGraphQLMutation.UpdateSpaceMemberOperation addOrRemove)
                                                throws WWException
```
    Update the members of a Space and its title, returning a UpdateSpaceContainer containing an Array of members updated and Space object with the new title
    
    Parameters:
    
    id - String id for the Space to update
    
    title - String title of the newly-created Space
    
    members - List of member IDs to add / remove as members
    
    addOrRemove - UpdateSpaceMemberOperation enum whether members should be added to the Space or removed
    
    Returns:
    
    UpdateSpaceContainer containing Array of members updated and Space
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.6.0
  - updateSpaceWithMutation
```
public UpdateSpaceContainer updateSpaceWithMutation(SpaceUpdateGraphQLMutation mutationObject)
                                             throws WWException
```
    Updates a Space with a query, returning a UpdateSpaceContainer containing an Array of members updated and Space object with the new title
    
    Parameters:
    
    mutationObject - SpaceUpdateGraphQLMutation containing the details to update
    
    Returns:
    
    UpdateSpaceContainer containing Array of members updated and Space
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.6.0
  - addSpaceMembers
```
public ArrayList<String> addSpaceMembers(String id,
                                         List<SpaceMembersAddDataSenderBuilder.SpaceMemberObject> members)
                                  throws WWException
```
    Add members to a Space, returning List of members updated
    
    Parameters:
    
    id - String id of the space to update
    
    members - List of member IDs to add / remove as members
    
    Returns:
    
    ArrayList of member IDs updated
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - removeSpaceMembers
```
public ArrayList<String> removeSpaceMembers(String id,
                                            List<String> members)
                                     throws WWException
```
    Remove members of a Space, returning List of members updated and the
    
    Parameters:
    
    id - String id of the space to update
    
    members - List of member IDs to remove as members
    
    Returns:
    
    ArrayList of member IDs updated
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - getSpaceById
```
public Space getSpaceById(String spaceId)
                   throws WWException
```
    Get a Space by using a spaceId
    
    Parameters:
    
    spaceId - String id for the Space
    
    Returns:
    
    Space details
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpaceWithQuery
```
public Space getSpaceWithQuery(SpaceGraphQLQuery query)
                        throws WWException
```
    getSpace by using a SpaceGraphQLQuery
    
    Parameters:
    
    query - GraphQLQuery for the call
    
    Returns:
    
    Space details
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getMe
```
public Person getMe()
             throws WWException
```
    Simplified access method, to load GraphQL query for getting Me object
    
    Returns:
    
    Person object relating to "me"
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPersonById
```
public Person getPersonById(String personId)
                     throws WWException
```
    Simplified access method, to load GraphQL query for getting Person by ID or "me" if personId is blank
    
    Parameters:
    
    personId - String, WWS id of the Person to return
    
    Returns:
    
    Person for relevant ID
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPersonByEmail
```
public Person getPersonByEmail(String personEmail)
                        throws WWException
```
    Simplified access method, to load GraphQL query for getting Person by email or "me" if personId is blank
    
    Parameters:
    
    personEmail - String, WWS email of the Person to return
    
    Returns:
    
    Person for relevant email
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPersonWithQuery
```
public Person getPersonWithQuery(PersonGraphQLQuery query)
                          throws WWException
```
    Get Person Object with GraphQL Query
    
    Parameters:
    
    query - PersonGraphQLQuery with selection and return criteria
    
    Returns:
    
    Person for relevant query
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getConversation
```
public Conversation getConversation(String conversationId)
                             throws WWException
```
    Get basic data Conversation object for relevant Conversation
    
    Parameters:
    
    conversationId - String conversation id
    
    Returns:
    
    Conversation for relevant query
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getConversationWithQuery
```
public Conversation getConversationWithQuery(ConversationGraphQLQuery query)
                                      throws WWException
```
    Get Conversation object with query
    
    Parameters:
    
    query - ConversationGraphQLQuery with selection and return criteria
    
    Returns:
    
    Conversation for relevant query
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getConversationWrapperWithQuery
```
public ConversationWrapper getConversationWrapperWithQuery(ConversationGraphQLQuery query)
                                                    throws WWException
```
    Get ConversationWrapper object with query. This allows access to the PageInfo object
    
    Parameters:
    
    query - ConversationGraphQLQuery with selection and return criteria
    
    Returns:
    
    ConversationWrapper for relevant query
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - getMessageById
```
public Message getMessageById(String messageId)
                       throws WWException
```
    Get a Message by using a messageId
    
    Parameters:
    
    messageId - String id of the message
    
    Returns:
    
    Message details
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getMessageWithQuery
```
public Message getMessageWithQuery(MessageGraphQLQuery query)
                            throws WWException
```
    Get a Message by using a messageId
    
    Parameters:
    
    query - MessageGraphQLQuery with selection and return criteria
    
    Returns:
    
    Message details
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpaceMembers
```
public List<Person> getSpaceMembers(String spaceId)
                             throws WWException
```
    Get basic data for Space Members for relevant Sapce
    
    Parameters:
    
    spaceId - String id for the Space
    
    Returns:
    
    Space for relevant ID
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpaceMembersWithQuery
```
public List<Person> getSpaceMembersWithQuery(SpaceMembersGraphQLQuery query)
                                      throws WWException
```
    Get Space Members with query
    
    Parameters:
    
    query - SpaceMembersGraphQLQuery with selection and return criteria
    
    Returns:
    
    Space Members for relevant query
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPeople
```
public List<Person> getPeople(List<String> ids)
                       throws WWException
```
    Gets People matching the passed ids
    
    Parameters:
    
    ids - List of String ids
    
    Returns:
    
    People matching the ids
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPeopleByName
```
public List<Person> getPeopleByName(String name)
                             throws WWException
```
    Gets People matching the single word name passed. This query does not work when authenticated as an application
    
    Parameters:
    
    name - String single word corresponding to part of a name
    
    Returns:
    
    People matching the name
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPeopleWithQuery
```
public List<Person> getPeopleWithQuery(PeopleGraphQLQuery query)
                                throws WWException
```
    Get People with query. Note: this just returns the People, not the associated PageInfo object
    
    Parameters:
    
    query - PeopleGraphQLQuery with selection and return criteria
    
    Returns:
    
    Space Members for relevant query
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPeopleContainerWithQuery
```
public MembersContainer getPeopleContainerWithQuery(PeopleGraphQLQuery query)
                                             throws WWException
```
    Parameters:
    
    query - PeopleGraphQLQuery with selection and return criteria
    
    Returns:
    
    MembersContainer for the relevant query including PageInfo object and People items
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - getMentioned
```
public List<Mentioned> getMentioned()
                             throws WWException
```
    Get Mentioned query with first 10 mentions. Note: this does not give access to thePageInfo object
    
    Returns:
    
    List of first 10 Mentioned objects
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - getMentioned
```
public List<Mentioned> getMentioned(MentionedGraphQLQuery query)
                             throws WWException
```
    Get Mentioned query with passed query. Note: this does not give access to thePageInfo object
    
    Parameters:
    
    query - MentionedGraphQLQuery with relevant parameters
    
    Returns:
    
    List of Mentioned objects
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - getMentionedContainerWithQuery
```
public MentionedContainer getMentionedContainerWithQuery(MentionedGraphQLQuery query)
                                                  throws WWException
```
    Parameters:
    
    query - MentionedGraphQLQuery with relevant parameters
    
    Returns:
    
    MentionedContainer container Mentioned objects and PageInfo object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0

Class WWGraphQLEndpoint

Constructor Summary

Method Summary

Methods inherited from class org.opencode4workspace.endpoints.AbstractWWGraphQLEndpoint

Methods inherited from class java.lang.Object

Constructor Detail

WWGraphQLEndpoint

Method Detail

getSpaces

getSpacesWithQuery

getSpacesContainerWithQuery

createSpace

createSpaceWithMutation

deleteSpace

updateSpaceTitle

updateSpaceMembers

updateSpaceMembersAndTitle

updateSpaceWithMutation

addSpaceMembers

removeSpaceMembers

getSpaceById

getSpaceWithQuery

getMe

getPersonById

getPersonByEmail

getPersonWithQuery

getConversation

getConversationWithQuery

getConversationWrapperWithQuery

getMessageById

getMessageWithQuery

getSpaceMembers

getSpaceMembersWithQuery

getPeople

getPeopleByName

getPeopleWithQuery

getPeopleContainerWithQuery

getMentioned

getMentioned

getMentionedContainerWithQuery