WWClient (Java SDK API Client 0.9.0-SNAPSHOT API)

java.lang.Object
- org.opencode4workspace.WWClient

All Implemented Interfaces:

Serializable, IWWClient
```
public class WWClient
extends Object
implements Serializable, IWWClient
```
Since:

0.5.0 Watson Workspace Apache HTTP Client class Manages setting up an HTTP Client for both users and applications

Author:

Christian Guedemann, Paul Withers

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.opencode4workspace.IWWClient
  IWWClient.ClientType

Constructor Summary

Constructors
Constructor and Description

WWClient()

Constructors
Constructor and Description
`WWClient()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArrayList<String>`	`addSpaceMembers(String id, List<SpaceMembersAddDataSenderBuilder.SpaceMemberObject> members)` Easy helper method for adding Space members returning List of member IDs updated
`void`	`authenticate()` Attempt authentication of the WWClient
`static WWClient`	`buildClientApplicationAccess(String appId, String appSecret, AuthenticationEndpoint authenticationEndpoint)` Creates an application-level WWClient, not associated with a specific user.
`static WWClient`	`buildClientUserAccess(String userToken, String appId, String appSecret, AuthenticationEndpoint authenticationEndpoint, String redirectTo)` Creates and returns a WWClient for a specific user
`static WWClient`	`buildClientUserAccessFromToken(String appId, String appSecret, PeopleToken token)` Creates and returns a WWClient for a specific user.
`Space`	`createSpace(String title)` Easy helper method to create a Space with a title
`Space`	`createSpace(String title, List<String> members)` Easy helper method to create a Space with a title and list of Members
`Space`	`createSpaceWithQuery(SpaceCreateGraphQLMutation mutationObject)` Easy helper method to create a Space with a SpaceCreateGraphQLMutation object
`boolean`	`deleteSpace(String id)` Easy helper method to delete a Space
`String`	`getAppCredentials()` Converts appId and appSecret into required content for Authorization header
`IWWClient.ClientType`	`getClientType()` Getter for ClientType, dependent upon the initialiser user
`Conversation`	`getConversationById(String conversationId)` Easy helper method to get a Conversation and its details by a conversation id
`Conversation`	`getConversationWithQuery(ConversationGraphQLQuery query)` Easy helper method to get a Conversation and its details with a query
`ConversationWrapper`	`getConversationWrapperWithQuery(ConversationGraphQLQuery query)` Easy helper method to get a ConversationWrapper and its details with a query, including access to PageInfo object
`GraphResultContainer`	`getCustomQuery(BaseGraphQLQuery query)` Perform a custom GraphQL query returning customised content for one or more fields.
`Date`	`getExpireDate()` Gets the time the token expires from the `AuthenticationResult`
`Object`	`getExpiresIn()` Gets the length of time until the token expires from the `AuthenticationResult`
`String`	`getJWTToken()` Gets JWT token for the user / application from the `AuthenticationResult`.
`Person`	`getMe()` Easy helper method to get My Person object.
`List<Mentioned>`	`getMentioned()` Easy helper method to get first 10 mentions for current user
`MentionedContainer`	`getMentionedContainerWithQuery(MentionedGraphQLQuery query)` Easy helper method to get mentions and PageInfo object for current user
`List<Mentioned>`	`getMentionedWithQuery(MentionedGraphQLQuery query)` Easy helper method to get mentions for current user
`Message`	`getMessageById(String messageId)` Easy helper method to get a Message and its details by id
`Message`	`getMessageWithQuery(MessageGraphQLQuery query)` Easy helper method to get a Message and its details with a query
`List<Person>`	`getPeople(List<String> ids)` Easy helper method to get Person objects with ids
`List<Person>`	`getPeopleByName(String name)` Easy helper method to get Person objects with part of a name
`MembersContainer`	`getPeopleContainerWithQuery(PeopleGraphQLQuery query)` Easy helper method to get Person objects with a query
`List<Person>`	`getPeopleWithQuery(PeopleGraphQLQuery query)` Easy helper method to get Person objects with a query
`Person`	`getPersonByEmail(String personEmail)` Easy helper method to get a Person with a person email.
`Person`	`getPersonById(String personId)` Easy helper method to get a Person with a person id.
`Person`	`getPersonWithQuery(PersonGraphQLQuery query)` Easy helper method to get a Person with a query
`String`	`getResultContent()` Getter for resultContent from relevant endpoint
`Space`	`getSpaceById(String spaceId)` Easy helper method to get a Space by a Space id
`List<Person>`	`getSpaceMembersById(String spaceId)` Easy helper method to get members for a space with the space id
`List<Person>`	`getSpaceMembersWithQuery(SpaceMembersGraphQLQuery query)` Easy helper method to get members of space with a query
`List<? extends Space>`	`getSpaces()` Easy helper method to get spaces from the WWClient
`SpacesContainer`	`getSpacesContainerWithQuery(SpacesGraphQLQuery query)` Easy helper method to get SpacesContainer with a query
`List<? extends Space>`	`getSpacesWithQuery(SpacesGraphQLQuery query)` Easy helper method to get Spaces with a query
`Space`	`getSpaceWithQuery(SpaceGraphQLQuery query)` Easy helper method to get a Space by using a SpaceGraphQLQuery
`String`	`getUserRefreshToken()` Gets the refreshtoken for a user authentication from the `AuthenticationResult`
`boolean`	`isAuthenticated()` Whether or not authentication has successfully occurred.
`boolean`	`isValid()` Tests whether the `AuthenticationResult` is valid
`FileResponse`	`postFileToSpace(File file, String spaceId)` Post a file to Watson Workspace
`FileResponse`	`postFileToSpace(File file, String spaceId, String imageSize)` Post an image file to Watson Workspace
`MessageResponse`	`postMessageToSpace(AppMessage message, String spaceId)` Easy helper method to post a Application Message to a Space
`PhotoResponse`	`postPhoto(File photo)`
`List<Focus>`	`postTextForFocusAnalysis(String text)` Post text for Watson Workspace to analyse for Focuses
`ArrayList<String>`	`removeSpaceMembers(String id, List<String> members)` Easy helper method for removing Space members returning List of member IDs updated
`void`	`setResultContent(String resultContent)` Setter for resultContent from relevant endpoint
`ArrayList<String>`	`updateSpaceMembers(String id, List<String> members, SpaceUpdateGraphQLMutation.UpdateSpaceMemberOperation addOrRemove)` Easy helper method for updating a Space members returning List of member IDs updated
`UpdateSpaceContainer`	`updateSpaceMembersAndTitle(String id, String title, List<String> members, SpaceUpdateGraphQLMutation.UpdateSpaceMemberOperation addOrRemove)` Easy helper method for updating a Space members and title, returning UpdateSpaceContainer with array of member IDs updated and Space object with updated title
`Space`	`updateSpaceTitle(String id, String newTitle)` Easy helper method for updating a Space Title returning Space object with updated Title
`UpdateSpaceContainer`	`updateSpaceWithMutation(SpaceUpdateGraphQLMutation mutationObject)` Easy helper method for updating a Space Title / members / both returning an UpdateSpaceContainer with updated Space details / updated members / both

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

- Constructor Detail
  - WWClient
```
public WWClient()
```
- Method Detail
  - buildClientUserAccess
```
public static WWClient buildClientUserAccess(String userToken,
                                             String appId,
                                             String appSecret,
                                             AuthenticationEndpoint authenticationEndpoint,
                                             String redirectTo)
```
    Creates and returns a WWClient for a specific user
    
    Parameters:
    
    userToken - String, the JWT user token to be passed, used to authenticate as the specific user
    
    appId - String, the ID for the application the code is being run from
    
    appSecret - String, the secret for the application the code is being run from
    
    authenticationEndpoint - AuthenticationEndpoint or any sub-class thereof. Typically WWAuthenticationEndpoint
    
    redirectTo - String, URL to redirect to after authentication
    
    Returns:
    
    WWClient, a Watson Workspace Client contructed with the passed params
    
    Since:
    
    0.5.0
  - buildClientApplicationAccess
```
public static WWClient buildClientApplicationAccess(String appId,
                                                    String appSecret,
                                                    AuthenticationEndpoint authenticationEndpoint)
```
    Creates an application-level WWClient, not associated with a specific user. There is no benefit serializing an AppToken, so there is no corresponding method for loading with an AppToken
    
    Parameters:
    
    appId - String, the ID for the application the code is being run from
    
    appSecret - String, the secret for the application the code is being run from
    
    authenticationEndpoint - AuthenticationEndpoint or any sub-class thereof. Typically WWAuthenticationEndpoint
    
    Returns:
    
    WWClient, a Watson Workspace Client contructed with the passed params
    
    Since:
    
    0.5.0
  - buildClientUserAccessFromToken
```
public static WWClient buildClientUserAccessFromToken(String appId,
                                                      String appSecret,
                                                      PeopleToken token)
```
    Creates and returns a WWClient for a specific user. This allows you to pass a serialized user token including the refreshToken
    
    Parameters:
    
    appId - String, the ID for the application the code is being run from
    
    appSecret - String, the secret for the application the code is being run from
    
    token - PeopleToken containing access details
    
    Returns:
    
    WWClient, a Watson Workspace Client contructed with the passed params
    
    Since:
    
    0.5.0
  - getClientType
```
public IWWClient.ClientType getClientType()
```
    Description copied from interface: IWWClient
    
    Getter for ClientType, dependent upon the initialiser user
    
    Specified by:
    
    getClientType in interface IWWClient
    
    Returns:
    
    IWWClient.ClientType.USER or IWWClient.ClientType.APPLICATON
  - getAppCredentials
```
public String getAppCredentials()
                         throws UnsupportedEncodingException
```
    Description copied from interface: IWWClient
    
    Converts appId and appSecret into required content for Authorization header
    
    Specified by:
    
    getAppCredentials in interface IWWClient
    
    Returns:
    
    String, content for Authorization header
    
    Throws:
    
    UnsupportedEncodingException - if the encoding option is not supported
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Description copied from interface: IWWClient
    
    Whether or not authentication has successfully occurred. Call IWWClient.authenticate() first
    
    Specified by:
    
    isAuthenticated in interface IWWClient
    
    Returns:
    
    boolean, whether or not already authenticated
  - authenticate
```
public void authenticate()
                  throws UnsupportedEncodingException,
                         WWException
```
    Description copied from interface: IWWClient
    
    Attempt authentication of the WWClient
    
    Specified by:
    
    authenticate in interface IWWClient
    
    Throws:
    
    UnsupportedEncodingException - Authorization header could not be constructed
    
    WWException - Some other error occurred during authentication
  - getJWTToken
```
public String getJWTToken()
```
    Description copied from interface: IWWClient
    
    Gets JWT token for the user / application from the AuthenticationResult. The JWT token is an expiring token associated with the appId and appSecret. From the documentation: "This JWT token is what you have to use in your App to pass to Watson Work Services on API calls so that you can use its services securely"
    
    Specified by:
    
    getJWTToken in interface IWWClient
    
    Returns:
    
    String, JWT token
  - getUserRefreshToken
```
public String getUserRefreshToken()
```
    Description copied from interface: IWWClient
    
    Gets the refreshtoken for a user authentication from the AuthenticationResult
    
    Specified by:
    
    getUserRefreshToken in interface IWWClient
    
    Returns:
    
    String, refresh token. A blank string for an application authentication
  - getExpiresIn
```
public Object getExpiresIn()
```
    Description copied from interface: IWWClient
    
    Gets the length of time until the token expires from the AuthenticationResult
    
    Specified by:
    
    getExpiresIn in interface IWWClient
    
    Returns:
    
    Object, a long that determines the time until expiry
  - getExpireDate
```
public Date getExpireDate()
```
    Description copied from interface: IWWClient
    
    Gets the time the token expires from the AuthenticationResult
    
    Specified by:
    
    getExpireDate in interface IWWClient
    
    Returns:
    
    Date, the time the token expires
  - isValid
```
public boolean isValid()
```
    Description copied from interface: IWWClient
    
    Tests whether the AuthenticationResult is valid
    
    Specified by:
    
    isValid in interface IWWClient
    
    Returns:
    
    boolean, whether or not valid
  - getSpaces
```
public List<? extends Space> getSpaces()
                                throws WWException
```
    Easy helper method to get spaces from the WWClient
    
    Returns:
    
    List of Space objects
    
    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
```
    Easy helper method to get Spaces with a query
    
    Parameters:
    
    query - SpacesGraphQLQuery containing query parameters
    
    Returns:
    
    List of Space objects
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpacesContainerWithQuery
```
public SpacesContainer getSpacesContainerWithQuery(SpacesGraphQLQuery query)
                                            throws WWException
```
    Easy helper method to get SpacesContainer with a query
    
    Parameters:
    
    query - SpacesGraphQLQuery containing query parameters
    
    Returns:
    
    SpacesContainer including PageInfo and Spaces items
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - createSpace
```
public Space createSpace(String title,
                         List<String> members)
                  throws WWException
```
    Easy helper method to 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
  - createSpace
```
public Space createSpace(String title)
                  throws WWException
```
    Easy helper method to create a Space with a title
    
    Parameters:
    
    title - String title for 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
  - createSpaceWithQuery
```
public Space createSpaceWithQuery(SpaceCreateGraphQLMutation mutationObject)
                           throws WWException
```
    Easy helper method to 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
```
    Easy helper method to delete a Space
    
    Parameters:
    
    id - String id for the Space
    
    Returns:
    
    boolean, whether or not the deletion 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
```
    Easy helper method for updating a Space Title 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
  - updateSpaceWithMutation
```
public UpdateSpaceContainer updateSpaceWithMutation(SpaceUpdateGraphQLMutation mutationObject)
                                             throws WWException
```
    Easy helper method for updating a Space Title / members / both returning an UpdateSpaceContainer with updated Space details / updated members / both
    
    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
  - updateSpaceMembers
```
public ArrayList<String> updateSpaceMembers(String id,
                                            List<String> members,
                                            SpaceUpdateGraphQLMutation.UpdateSpaceMemberOperation addOrRemove)
                                     throws WWException
```
    Easy helper method for updating a Space members returning List of member IDs 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
```
    Easy helper method for updating a Space members and title, returning UpdateSpaceContainer with array of member IDs updated and Space object with updated 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
  - addSpaceMembers
```
public ArrayList<String> addSpaceMembers(String id,
                                         List<SpaceMembersAddDataSenderBuilder.SpaceMemberObject> members)
                                  throws WWException
```
    Easy helper method for adding Space members returning List of member IDs updated
    
    Parameters:
    
    id - String id of the space to update
    
    members - List of String member IDs to add 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
```
    Easy helper method for removing Space members returning List of member IDs updated
    
    Parameters:
    
    id - String id of the space to update
    
    members - List of String 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
```
    Easy helper method to get a Space by a Space id
    
    Parameters:
    
    spaceId - id of the Space
    
    Returns:
    
    Space object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpaceWithQuery
```
public Space getSpaceWithQuery(SpaceGraphQLQuery query)
                        throws WWException
```
    Easy helper method to get a Space by using a SpaceGraphQLQuery
    
    Parameters:
    
    query - SpaceGraphQLQuery for the call
    
    Returns:
    
    Space object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getConversationById
```
public Conversation getConversationById(String conversationId)
                                 throws WWException
```
    Easy helper method to get a Conversation and its details by a conversation id
    
    Parameters:
    
    conversationId - String id of the conversation
    
    Returns:
    
    Conversation object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getConversationWithQuery
```
public Conversation getConversationWithQuery(ConversationGraphQLQuery query)
                                      throws WWException
```
    Easy helper method to get a Conversation and its details with a query
    
    Parameters:
    
    query - ConversationGraphQLQuery containing query parameters
    
    Returns:
    
    Conversation object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getConversationWrapperWithQuery
```
public ConversationWrapper getConversationWrapperWithQuery(ConversationGraphQLQuery query)
                                                    throws WWException
```
    Easy helper method to get a ConversationWrapper and its details with a query, including access to PageInfo object
    
    Parameters:
    
    query - ConversationGraphQLQuery containing query parameters
    
    Returns:
    
    ConversationWrapper object which also has access to PageInfo object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getMessageById
```
public Message getMessageById(String messageId)
                       throws WWException
```
    Easy helper method to get a Message and its details by id
    
    Parameters:
    
    messageId - String id of the Message
    
    Returns:
    
    Message details of the Message
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getMessageWithQuery
```
public Message getMessageWithQuery(MessageGraphQLQuery query)
                            throws WWException
```
    Easy helper method to get a Message and its details with a query
    
    Parameters:
    
    query - MessageGraphQLQuery containing query parameters
    
    Returns:
    
    Message details of the Message
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPersonById
```
public Person getPersonById(String personId)
                     throws WWException
```
    Easy helper method to get a Person with a person id. The method gets "me" if id is blank.
    
    Parameters:
    
    personId - String id of the person
    
    Returns:
    
    Person object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPersonByEmail
```
public Person getPersonByEmail(String personEmail)
                        throws WWException
```
    Easy helper method to get a Person with a person email. The method gets "me" if email is blank.
    
    Parameters:
    
    personEmail - String email of the person
    
    Returns:
    
    Person object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPersonWithQuery
```
public Person getPersonWithQuery(PersonGraphQLQuery query)
                          throws WWException
```
    Easy helper method to get a Person with a query
    
    Parameters:
    
    query - PersonGraphQLQuery containing query parameters
    
    Returns:
    
    Person object
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpaceMembersById
```
public List<Person> getSpaceMembersById(String spaceId)
                                 throws WWException
```
    Easy helper method to get members for a space with the space id
    
    Parameters:
    
    spaceId - String id of the space
    
    Returns:
    
    List of Person objects for the members of the space
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getSpaceMembersWithQuery
```
public List<Person> getSpaceMembersWithQuery(SpaceMembersGraphQLQuery query)
                                      throws WWException
```
    Easy helper method to get members of space with a query
    
    Parameters:
    
    query - SpaceMembersGraphQLQuery containing query parameters
    
    Returns:
    
    List of Person objects for the members of the space
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getMe
```
public Person getMe()
             throws WWException
```
    Easy helper method to get My Person object. This will not work from a client authenticated as an application.
    
    Returns:
    
    Person object relating to current authenticated user
    
    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
```
    Easy helper method to get Person objects with ids
    
    Parameters:
    
    ids - List of String person ids
    
    Returns:
    
    List of Person objects for the ids passed
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPeopleByName
```
public List<Person> getPeopleByName(String name)
                             throws WWException
```
    Easy helper method to get Person objects with part of a name
    
    Parameters:
    
    name - String part of a name. This needs to be a single word
    
    Returns:
    
    List of Person objects for the name passed
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPeopleWithQuery
```
public List<Person> getPeopleWithQuery(PeopleGraphQLQuery query)
                                throws WWException
```
    Easy helper method to get Person objects with a query
    
    Parameters:
    
    query - PeopleGraphQLQuery containing query parameters
    
    Returns:
    
    List of Person objects for the query passed
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getPeopleContainerWithQuery
```
public MembersContainer getPeopleContainerWithQuery(PeopleGraphQLQuery query)
                                             throws WWException
```
    Easy helper method to get Person objects with a query
    
    Parameters:
    
    query - PeopleGraphQLQuery containing query parameters
    
    Returns:
    
    MembersContainer containing PageInfo and Person objects for the querypassed
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.5.0
  - getMentioned
```
public List<Mentioned> getMentioned()
                             throws WWException
```
    Easy helper method to get first 10 mentions for current user
    
    Returns:
    
    List of mentions
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - getMentionedWithQuery
```
public List<Mentioned> getMentionedWithQuery(MentionedGraphQLQuery query)
                                      throws WWException
```
    Easy helper method to get mentions for current user
    
    Parameters:
    
    query - MentionedGraphQLQuery containing query parameters
    
    Returns:
    
    List of mentions
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - getMentionedContainerWithQuery
```
public MentionedContainer getMentionedContainerWithQuery(MentionedGraphQLQuery query)
                                                  throws WWException
```
    Easy helper method to get mentions and PageInfo object for current user
    
    Parameters:
    
    query - MentionedGraphQLQuery containing query parameters
    
    Returns:
    
    MentionedContainer including PageInfo object and items
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - postMessageToSpace
```
public MessageResponse postMessageToSpace(AppMessage message,
                                          String spaceId)
                                   throws WWException
```
    Easy helper method to post a Application Message to a Space
    
    Parameters:
    
    message - Application Message (use AppMessageBuilder) to post
    
    spaceId - ID of the Space, where the message should be posted
    
    Returns:
    
    MessageResponse
    
    Throws:
    
    WWException - contains an error message, if the post was unsuccessful
  - postFileToSpace
```
public FileResponse postFileToSpace(File file,
                                    String spaceId)
                             throws WWException
```
    Post a file to Watson Workspace
    
    Parameters:
    
    file - to post into the Workspace
    
    spaceId - String id of the space to post to
    
    Returns:
    
    FileResponse object corresponding to the successful posting of the file
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.7.0
  - postFileToSpace
```
public FileResponse postFileToSpace(File file,
                                    String spaceId,
                                    String imageSize)
                             throws WWException
```
    Post an image file to Watson Workspace
    
    Parameters:
    
    file - to post into the Workspace
    
    spaceId - String id of the space to post to
    
    imageSize - image size as height x width, e.g. 200x200. Only blank or null values are current supported
    
    Returns:
    
    FileResponse object corresponding to the successful posting of the file
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.7.0
  - postPhoto
```
public PhotoResponse postPhoto(File photo)
                        throws WWException
```
    Parameters:
    
    photo - File containing a jpeg to post. Should be less than 300Kb
    
    Returns:
    
    PhotoResponse from Watson Workspace
    
    Throws:
    
    WWException - contains an error message, if the query was unsuccessful
    
    Since:
    
    0.7.0
  - getCustomQuery
```
public GraphResultContainer getCustomQuery(BaseGraphQLQuery query)
                                    throws WWException
```
    Perform a custom GraphQL query returning customised content for one or more fields. Return objects may also be cast to variables
    
    Parameters:
    
    query - BaseGraphQLQuery custom query to run
    
    Returns:
    
    GraphResultContainer containing Data and Errors
    
    Throws:
    
    WWException - contains an error message, if the query was unsuccessful
    
    Since:
    
    0.7.0
  - postTextForFocusAnalysis
```
public List<Focus> postTextForFocusAnalysis(String text)
                                     throws WWException
```
    Post text for Watson Workspace to analyse for Focuses
    
    Parameters:
    
    text - String text for Watson Work Services to analyse
    
    Returns:
    
    List of Focus objects based on analysis
    
    Throws:
    
    WWException - containing an error message, if the request was unsuccessful
    
    Since:
    
    0.8.0
  - getResultContent
```
public String getResultContent()
```
    Description copied from interface: IWWClient
    
    Getter for resultContent from relevant endpoint
    
    Specified by:
    
    getResultContent in interface IWWClient
    
    Returns:
    
    result content (data / errors) as JSON String
  - setResultContent
```
public void setResultContent(String resultContent)
```
    Description copied from interface: IWWClient
    
    Setter for resultContent from relevant endpoint
    
    Specified by:
    
    setResultContent in interface IWWClient
    
    Parameters:
    
    resultContent - result content (data / errors) as JSON String

Class WWClient

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencode4workspace.IWWClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WWClient

Method Detail

buildClientUserAccess

buildClientApplicationAccess

buildClientUserAccessFromToken

getClientType

getAppCredentials

isAuthenticated

authenticate

getJWTToken

getUserRefreshToken

getExpiresIn

getExpireDate

isValid

getSpaces

getSpacesWithQuery

getSpacesContainerWithQuery

createSpace

createSpace

createSpaceWithQuery

deleteSpace

updateSpaceTitle

updateSpaceWithMutation

updateSpaceMembers

updateSpaceMembersAndTitle

addSpaceMembers

removeSpaceMembers

getSpaceById

getSpaceWithQuery

getConversationById

getConversationWithQuery

getConversationWrapperWithQuery

getMessageById

getMessageWithQuery

getPersonById

getPersonByEmail

getPersonWithQuery

getSpaceMembersById

getSpaceMembersWithQuery

getMe

getPeople

getPeopleByName

getPeopleWithQuery

getPeopleContainerWithQuery

getMentioned

getMentionedWithQuery

getMentionedContainerWithQuery

postMessageToSpace

postFileToSpace

postFileToSpace

postPhoto

getCustomQuery

postTextForFocusAnalysis

getResultContent

setResultContent