public class WWGraphQLEndpoint extends AbstractWWGraphQLEndpoint
Constructor and Description |
---|
WWGraphQLEndpoint(WWClient client) |
Modifier and Type | Method and Description |
---|---|
Conversation |
getConversation(String conversationId)
Get basic data Conversation object for relevant Conversation
|
Conversation |
getConversationWithQuery(ConversationGraphQLQuery query)
Get Conversation object with query
|
Person |
getMe()
Simplified access method, to load GraphQL query for getting Me object
|
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.
|
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
|
List<? extends Space> |
getSpacesWithQuery(SpacesGraphQLQuery query)
getSpaces by using a SpacesGraphQLQuery
|
Space |
getSpaceWithQuery(SpaceGraphQLQuery query)
getSpace by using a SpaceGraphQLQuery
|
executeRequest, getClient, getProfileDump, getRequest, getResultContainer, getResultContent, parseResultContainer, setProfileDump, setRequest, setResultContainer, setResultContent
public WWGraphQLEndpoint(WWClient client)
client
- WWClient containing authentication details and tokenpublic List<? extends Space> getSpaces() throws WWException
WWException
- containing an error message, if the request was unsuccessfulpublic List<? extends Space> getSpacesWithQuery(SpacesGraphQLQuery query) throws WWException
query
- GraphQLQuery for the callWWException
- containing an error message, if the request was unsuccessfulpublic Space getSpaceById(String spaceId) throws WWException
spaceId
- String id for the SpaceWWException
- containing an error message, if the request was unsuccessfulpublic Space getSpaceWithQuery(SpaceGraphQLQuery query) throws WWException
query
- GraphQLQuery for the callWWException
- containing an error message, if the request was unsuccessfulpublic Person getMe() throws WWException
WWException
- containing an error message, if the request was unsuccessfulpublic Person getPersonById(String personId) throws WWException
personId
- String, WWS id of the Person to returnWWException
- containing an error message, if the request was unsuccessfulpublic Person getPersonByEmail(String personEmail) throws WWException
personEmail
- String, WWS email of the Person to returnWWException
- containing an error message, if the request was unsuccessfulpublic Person getPersonWithQuery(PersonGraphQLQuery query) throws WWException
query
- PersonGraphQLQuery with selection and return criteriaWWException
- containing an error message, if the request was unsuccessfulpublic Conversation getConversation(String conversationId) throws WWException
conversationId
- String conversation idWWException
- containing an error message, if the request was unsuccessfulpublic Conversation getConversationWithQuery(ConversationGraphQLQuery query) throws WWException
query
- ConversationGraphQLQuery with selection and return criteriaWWException
- containing an error message, if the request was unsuccessfulpublic Message getMessageById(String messageId) throws WWException
messageId
- String id of the messageWWException
- containing an error message, if the request was unsuccessfulpublic Message getMessageWithQuery(MessageGraphQLQuery query) throws WWException
query
- MessageGraphQLQuery with selection and return criteriaWWException
- containing an error message, if the request was unsuccessfulpublic List<Person> getSpaceMembers(String spaceId) throws WWException
spaceId
- String id for the SpaceWWException
- containing an error message, if the request was unsuccessfulpublic List<Person> getSpaceMembersWithQuery(SpaceMembersGraphQLQuery query) throws WWException
query
- SpaceMembersGraphQLQuery with selection and return criteriaWWException
- containing an error message, if the request was unsuccessfulpublic List<Person> getPeople(List<String> ids) throws WWException
ids
- List of String idsWWException
- containing an error message, if the request was unsuccessfulpublic List<Person> getPeopleByName(String name) throws WWException
name
- String single word corresponding to part of a nameWWException
- containing an error message, if the request was unsuccessfulpublic List<Person> getPeopleWithQuery(PeopleGraphQLQuery query) throws WWException
query
- PeopleGraphQLQuery with selection and return criteriaWWException
- containing an error message, if the request was unsuccessfulCopyright © 2017 OpenNTF. All rights reserved.