A B C E G I L M O P S T U V

A

addAll() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildTypeProperties.Builder

This method adds "all" to the list of child types to be expanded.

addAncestors() - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds "ancestors" as a property to be expanded.

addAttachment() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildrenProperties.Builder

This method adds "attachment" type children to the list of children to be expanded.

addAttachment() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildTypeProperties.Builder

This method adds "attachment" to the list of child types to be expanded.

addAttachment() - Method in class com.github.crob1140.confluence.content.expand.ExpandedDescendantsProperties.Builder

This method adds "attachment" to the list of descendant types to be expanded.

addBody(ContentBodyType, ExpandedBodyFormatProperties) - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds the given properties of the given body type to the list of expanded properties.

addChildren(ExpandedChildrenProperties) - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds the given children to the list of expanded properties.

addChildTypes(ExpandedChildTypeProperties) - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds the given child types to the list of expanded properties.

addComment() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildrenProperties.Builder

This method adds "comment" type children to the list of children to be expanded.

addComment() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildTypeProperties.Builder

This method adds "comment" to the list of child types to be expanded.

addComment() - Method in class com.github.crob1140.confluence.content.expand.ExpandedDescendantsProperties.Builder

This method adds "comment" to the list of descendant types to be expanded.

addContainer() - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds "container" as a property to be expanded.

addContributors() - Method in class com.github.crob1140.confluence.content.expand.ExpandedHistoryProperties.Builder

This method adds "contributors" as a property to be expanded.

addCurrentUser() - Method in class com.github.crob1140.confluence.content.expand.ExpandedMetadataProperties.Builder

This method adds "currentuser" as a property to be expanded.

addDescendants(ExpandedDescendantsProperties) - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds the given descedants to the list of expanded properties.

addEmbeddedContent() - Method in class com.github.crob1140.confluence.content.expand.ExpandedBodyFormatProperties.Builder

This method adds "embeddedContent" as a property to be expanded.

addFrontEnd() - Method in class com.github.crob1140.confluence.content.expand.ExpandedMetadataProperties.Builder

This method adds "frontend" as a property to be expanded.

addHistory(ExpandedHistoryProperties) - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds the given history to the list of expanded properties.

addLabel(String) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method adds a label to the content created by the request, with the global prefix.

addLabel(String, LabelPrefix) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method adds a label to the content created by the request with the given value and prefix.

addLabel(String) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method adds a label to the content updated by the request, with the global prefix.

addLabel(String, LabelPrefix) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method adds a label to the content updated by the request with the given value and prefix.

addLabels() - Method in class com.github.crob1140.confluence.content.expand.ExpandedMetadataProperties.Builder

This method adds "labels" as a property to be expanded.

addLastUpdated() - Method in class com.github.crob1140.confluence.content.expand.ExpandedHistoryProperties.Builder

This method adds "lastUpdated" as a property to be expanded.

addMediaToken() - Method in class com.github.crob1140.confluence.content.expand.ExpandedBodyFormatProperties.Builder

This method adds "mediaToken" as a property to be expanded.

addMetadata(ExpandedMetadataProperties) - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds the given metadata to the list of expanded properties.

addNextVersion() - Method in class com.github.crob1140.confluence.content.expand.ExpandedHistoryProperties.Builder

This method adds "nextVersion" as a property to be expanded.

addOperations() - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds "operations" as a property to be expanded.

addPage() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildrenProperties.Builder

This method adds "page" type children to the list of children to be expanded.

addPage() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildTypeProperties.Builder

This method adds "page" to the list of child types to be expanded.

addPage() - Method in class com.github.crob1140.confluence.content.expand.ExpandedDescendantsProperties.Builder

This method adds "page" to the list of descendant types to be expanded.

addPreviousVersion() - Method in class com.github.crob1140.confluence.content.expand.ExpandedHistoryProperties.Builder

This method adds "previousVersion" as a property to be expanded.

addProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedMetadataProperties.Builder

This method adds "properties" as a property to be expanded.

addReadGroups() - Method in class com.github.crob1140.confluence.content.expand.ExpandedRestrictionProperties.Builder

This method adds "read.restrictions.group" as a property to be expanded.

addReadUsers() - Method in class com.github.crob1140.confluence.content.expand.ExpandedRestrictionProperties.Builder

This method adds "read.restrictions.user" as a property to be expanded.

addRepresentation() - Method in class com.github.crob1140.confluence.content.expand.ExpandedBodyFormatProperties.Builder

This method adds "representation" as a property to be expanded.

addRestrictions(ExpandedRestrictionProperties) - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds the given restrictions to the list of expanded properties.

addSpace() - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds "space" as a property to be expanded.

addUpdateGroups() - Method in class com.github.crob1140.confluence.content.expand.ExpandedRestrictionProperties.Builder

This method adds "update.restrictions.group as a property to be expanded.

addUpdateUsers() - Method in class com.github.crob1140.confluence.content.expand.ExpandedRestrictionProperties.Builder

This method adds "update.restrictions.user" as a property to be expanded.

addValue() - Method in class com.github.crob1140.confluence.content.expand.ExpandedBodyFormatProperties.Builder

This method adds "value" as a property to be expanded.

addVersion() - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method adds "version" as a property to be expanded.

addWebResource() - Method in class com.github.crob1140.confluence.content.expand.ExpandedBodyFormatProperties.Builder

This method adds "webresource" as a property to be expanded.

AuthMethod - Interface in com.github.crob1140.confluence.auth

This interface defines the methods required for a HTTP authentication method.

B

BasicAuth - Class in com.github.crob1140.confluence.auth

This class represents the Basic HTTP authentication scheme.

BasicAuth(String, String) - Constructor for class com.github.crob1140.confluence.auth.BasicAuth

This constructor creates a new instance of BasicAuth using the given username and password.

build() - Method in class com.github.crob1140.confluence.content.Content.Builder

This method creates an instance of Content using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.content.expand.ExpandedBodyFormatProperties.Builder

This method creates an instance of ExpandedBodyFormatProperties using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildrenProperties.Builder

This method creates an instance of ExpandedChildrenProperties using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildTypeProperties.Builder

This method creates an instance of ExpandedChildTypeProperties using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

This method creates an instance of ExpandedContentProperties using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.content.expand.ExpandedDescendantsProperties.Builder

This method creates an instance of ExpandedDescendantsProperties using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.content.expand.ExpandedHistoryProperties.Builder

This method creates an instance of ExpandedHistoryProperties using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.content.expand.ExpandedMetadataProperties.Builder

This method creates an instance of ExpandedMetadataProperties using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.content.expand.ExpandedRestrictionProperties.Builder

This method creates an instance of ExpandedRestrictionProperties using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method creates an instance of CreateContentRequest using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method creates an instance of GetContentRequest using the values that were set on this instance.

build() - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method creates an instance of UpdateContentRequest using the values that were set on this instance.

Builder() - Constructor for class com.github.crob1140.confluence.content.Content.Builder

Builder() - Constructor for class com.github.crob1140.confluence.content.expand.ExpandedBodyFormatProperties.Builder

Builder() - Constructor for class com.github.crob1140.confluence.content.expand.ExpandedChildrenProperties.Builder

Builder() - Constructor for class com.github.crob1140.confluence.content.expand.ExpandedChildTypeProperties.Builder

Builder() - Constructor for class com.github.crob1140.confluence.content.expand.ExpandedContentProperties.Builder

Builder() - Constructor for class com.github.crob1140.confluence.content.expand.ExpandedDescendantsProperties.Builder

Builder() - Constructor for class com.github.crob1140.confluence.content.expand.ExpandedHistoryProperties.Builder

Builder() - Constructor for class com.github.crob1140.confluence.content.expand.ExpandedMetadataProperties.Builder

Builder() - Constructor for class com.github.crob1140.confluence.content.expand.ExpandedRestrictionProperties.Builder

Builder() - Constructor for class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

Builder() - Constructor for class com.github.crob1140.confluence.requests.GetContentRequest.Builder

Builder() - Constructor for class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

C

com.github.crob1140.confluence - package com.github.crob1140.confluence

com.github.crob1140.confluence.auth - package com.github.crob1140.confluence.auth

com.github.crob1140.confluence.content - package com.github.crob1140.confluence.content

com.github.crob1140.confluence.content.expand - package com.github.crob1140.confluence.content.expand

com.github.crob1140.confluence.errors - package com.github.crob1140.confluence.errors

com.github.crob1140.confluence.requests - package com.github.crob1140.confluence.requests

com.github.crob1140.confluence.spaces - package com.github.crob1140.confluence.spaces

com.github.crob1140.confluence.users - package com.github.crob1140.confluence.users

ConfluenceClient - Class in com.github.crob1140.confluence

This class sends requests to a Confluence Cloud server.

ConfluenceClient(WebTarget) - Constructor for class com.github.crob1140.confluence.ConfluenceClient

This constructor creates a client that can send requests to the Confluence Cloud server located at the given target.

ConfluenceClient(WebTarget, AuthMethod) - Constructor for class com.github.crob1140.confluence.ConfluenceClient

This constructor creates a client that can send requests to the Confluence Cloud server located at the given target.

ConfluenceRequest - Class in com.github.crob1140.confluence.requests

This class represents a HTTP request performed against the Confluence REST API

ConfluenceRequest() - Constructor for class com.github.crob1140.confluence.requests.ConfluenceRequest

ConfluenceRequestException - Exception in com.github.crob1140.confluence.errors

This class represents an error response returned from the Confluence server.

ConfluenceRequestException(Integer, String) - Constructor for exception com.github.crob1140.confluence.errors.ConfluenceRequestException

This constructor creates a new instance using the given status code and message.

ConfluenceRequestException(Integer, String, ErrorData) - Constructor for exception com.github.crob1140.confluence.errors.ConfluenceRequestException

This constructor creates a new instance using the given status code, message and data.

Content - Class in com.github.crob1140.confluence.content

This class represents content within the Confluence Cloud server.

Content.Builder - Class in com.github.crob1140.confluence.content

This class can be used to construct an instance of Content for the purposes of creating or modifying some content on the Confluence Cloud server.

ContentBody - Class in com.github.crob1140.confluence.content

This class represents the body of a content object in the Confluence Cloud server.

ContentBody(ContentBodyType, String) - Constructor for class com.github.crob1140.confluence.content.ContentBody

This constructor creates the content body using the value defined for a given type.

ContentBodyFormat - Class in com.github.crob1140.confluence.content

This class represents the format of each body type contained within an instance of ContentBody.

ContentBodyFormat(String, String) - Constructor for class com.github.crob1140.confluence.content.ContentBodyFormat

This constructor creates a format with the given value and representation.

ContentBodyType - Enum in com.github.crob1140.confluence.content

This enumerable represents the possible types that can be defined for an instance of ContentBody.

ContentStatus - Enum in com.github.crob1140.confluence.content

This enumerable defines the possible statuses for an instance of Content.

createContent(CreateContentRequest) - Method in class com.github.crob1140.confluence.ConfluenceClient

This method sends a request to the Confluence Cloud server to create the content defined in the given CreateContentRequest.

CreateContentRequest - Class in com.github.crob1140.confluence.requests

This class represents a request to create content in the Confluence Cloud server.

CreateContentRequest.Builder - Class in com.github.crob1140.confluence.requests

This class can be used to construct an instance of CreateContentRequest.

E

Error - Class in com.github.crob1140.confluence.errors

This class represents an error contained within an instance of ErrorData.

Error() - Constructor for class com.github.crob1140.confluence.errors.Error

ErrorData - Class in com.github.crob1140.confluence.errors

This class represents the data contained within an instance of ErrorResponse.

ErrorData() - Constructor for class com.github.crob1140.confluence.errors.ErrorData

ErrorMessage - Class in com.github.crob1140.confluence.errors

This class represents the message contained within an instance of Error.

ErrorMessage() - Constructor for class com.github.crob1140.confluence.errors.ErrorMessage

ErrorResponse - Class in com.github.crob1140.confluence.errors

This class represents the response entity returned from a Confluence Cloud serve when an error occurs.

ErrorResponse() - Constructor for class com.github.crob1140.confluence.errors.ErrorResponse

ExpandedBodyFormatProperties - Class in com.github.crob1140.confluence.content.expand

This class represents the properties that can be expanded in a ContentBodyFormat instance returned from the Confluence Cloud server.

ExpandedBodyFormatProperties.Builder - Class in com.github.crob1140.confluence.content.expand

This class can be used to construct an instance of ExpandedBodyFormatProperties.

ExpandedChildrenProperties - Class in com.github.crob1140.confluence.content.expand

This class represents the children that can be expanded in a Content instance returned from the Confluence Cloud server.

ExpandedChildrenProperties.Builder - Class in com.github.crob1140.confluence.content.expand

This class can be used to construct an instance of ExpandedChildrenProperties.

ExpandedChildTypeProperties - Class in com.github.crob1140.confluence.content.expand

This class represents the child types that can be expanded in a Content instance returned from the Confluence Cloud server.

ExpandedChildTypeProperties.Builder - Class in com.github.crob1140.confluence.content.expand

This class can be used to construct an instance of ExpandedChildTypeProperties.

ExpandedContentProperties - Class in com.github.crob1140.confluence.content.expand

This class represents the properties that can be expanded in a Content instance returned from the Confluence Cloud server.

ExpandedContentProperties.Builder - Class in com.github.crob1140.confluence.content.expand

This class can be used to construct an instance of ExpandedContentProperties.

ExpandedDescendantsProperties - Class in com.github.crob1140.confluence.content.expand

This class represents the descendants that can be expanded in a Content instance returned from the Confluence Cloud server.

ExpandedDescendantsProperties.Builder - Class in com.github.crob1140.confluence.content.expand

This class can be used to construct an instance of ExpandedDescendantsProperties.

ExpandedHistoryProperties - Class in com.github.crob1140.confluence.content.expand

This class represents the history that can be expanded in a Content instance returned from the Confluence Cloud server.

ExpandedHistoryProperties.Builder - Class in com.github.crob1140.confluence.content.expand

This class can be used to construct an instance of ExpandedHistoryProperties.

ExpandedMetadataProperties - Class in com.github.crob1140.confluence.content.expand

This class represents the metadata that can be expanded in a Content instance returned from the Confluence Cloud server.

ExpandedMetadataProperties.Builder - Class in com.github.crob1140.confluence.content.expand

This class can be used to construct an instance of ExpandedMetadataProperties.

ExpandedRestrictionProperties - Class in com.github.crob1140.confluence.content.expand

This class represents the restrictions that can be expanded in a Content instance returned from the Confluence Cloud server.

ExpandedRestrictionProperties.Builder - Class in com.github.crob1140.confluence.content.expand

This class can be used to construct an instance of ExpandedRestrictionProperties.

G

getAcceptedResponseType() - Method in class com.github.crob1140.confluence.requests.ConfluenceRequest

This method returns the media type that is expected for the response.

getAccountId() - Method in class com.github.crob1140.confluence.users.User

This method returns the account ID of the user.

getAncestors() - Method in class com.github.crob1140.confluence.content.Content

This method returns the ancestors of this content.

getArgs() - Method in class com.github.crob1140.confluence.errors.ErrorMessage

This method returns the arguments for the error message.

getAuthHeaderValue() - Method in interface com.github.crob1140.confluence.auth.AuthMethod

This method generates a value to be passed in the "Authorization" header of any HTTP requests using this authorization method.

getAuthHeaderValue() - Method in class com.github.crob1140.confluence.auth.BasicAuth

This method generates a value to be passed in the "Authorization" header of any HTTP requests using this authorization method.

getAuthHeaderValue() - Method in class com.github.crob1140.confluence.auth.TokenAuth

This method generates a value to be passed in the "Authorization" header of any HTTP requests using this authorization method.

getBody() - Method in class com.github.crob1140.confluence.content.Content

This method returns the body of this content.

getBodyEntity() - Method in class com.github.crob1140.confluence.requests.ConfluenceRequest

This method returns the entity that is sent in the body of the request.

getBodyEntity() - Method in class com.github.crob1140.confluence.requests.CreateContentRequest

This method returns the entity that is sent in the body of the request.

getBodyEntity() - Method in class com.github.crob1140.confluence.requests.GetContentRequest

This method returns the entity that is sent in the body of the request.

getBodyEntity() - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest

This method returns the entity that is sent in the body of the request.

getBy() - Method in class com.github.crob1140.confluence.content.Version

This method returns the user that created the content.

getContent(GetContentRequest) - Method in class com.github.crob1140.confluence.ConfluenceClient

This method sends a request to the Confluence Cloud server to retrieve content matching the conditions set in the given GetContentRequest.

GetContentRequest - Class in com.github.crob1140.confluence.requests

This class represents a request to get content from the Confluence Cloud server.

GetContentRequest.Builder - Class in com.github.crob1140.confluence.requests

This class can be used to construct an instance of GetContentRequest.

GetContentResponse - Class in com.github.crob1140.confluence.requests

This class represents the response that is returned for a GetContentRequest.

GetContentResponse(List<Content>) - Constructor for class com.github.crob1140.confluence.requests.GetContentResponse

This constructor initialises the response with the given set of results.

getContentType() - Method in class com.github.crob1140.confluence.requests.ConfluenceRequest

This method returns the content type of this request.

getData() - Method in exception com.github.crob1140.confluence.errors.ConfluenceRequestException

This method returns the data contained within the error response.

getData() - Method in class com.github.crob1140.confluence.errors.ErrorResponse

This method contains the data contained within the error response.

getDisplayName() - Method in class com.github.crob1140.confluence.users.User

This method returns the display name of the user.

getErrors() - Method in class com.github.crob1140.confluence.errors.ErrorData

This method returns all of the associated errors.

getHeight() - Method in class com.github.crob1140.confluence.users.ProfilePicture

This method returns the height of the profile picture, in pixels.

getId() - Method in class com.github.crob1140.confluence.content.Content

This method returns the unique identifier for the content.

getId() - Method in class com.github.crob1140.confluence.spaces.Space

This method returns the unique identifer for the space.

getIdentifier() - Method in enum com.github.crob1140.confluence.content.ContentBodyType

This method returns the unique identifier for the body type.

getIdentifier() - Method in enum com.github.crob1140.confluence.content.ContentStatus

This method returns the unique identifier of the status.

getIdentifier() - Method in enum com.github.crob1140.confluence.content.LabelPrefix

This method returns the identifier for the prefix.

getIdentifier() - Method in enum com.github.crob1140.confluence.content.SortDirection

This method returns the identifier for the direction.

getIdentifier() - Method in enum com.github.crob1140.confluence.content.StandardContentType

This method returns the identifier for the type.

getIdentifier() - Method in enum com.github.crob1140.confluence.spaces.SpaceStatus

This method returns the unique identifier for the space status.

getIdentifier() - Method in enum com.github.crob1140.confluence.spaces.SpaceType

This method returns the unique identifier for the space type.

getIdentifier() - Method in enum com.github.crob1140.confluence.users.UserType

This method returns the unique identifier for the user type.

getKey() - Method in class com.github.crob1140.confluence.spaces.Space

This method returns the key of the space.

getLabels() - Method in class com.github.crob1140.confluence.content.Metadata

This method returns the labels on the content corresponding to this metadata.

getMessage() - Method in class com.github.crob1140.confluence.errors.Error

This method returns the message contained within the error.

getMessage() - Method in class com.github.crob1140.confluence.errors.ErrorResponse

This method returns the method contained within the error response.

getMetadata() - Method in class com.github.crob1140.confluence.content.Content

This method returns the metadata of this content.

getMethod() - Method in class com.github.crob1140.confluence.requests.ConfluenceRequest

This method returns the HTTP method used by this request.

getMethod() - Method in class com.github.crob1140.confluence.requests.CreateContentRequest

This method returns the HTTP method used by this request.

getMethod() - Method in class com.github.crob1140.confluence.requests.GetContentRequest

This method returns the HTTP method used by this request.

getMethod() - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest

This method returns the HTTP method used by this request.

getName() - Method in class com.github.crob1140.confluence.content.Label

This method returns the name of this label.

getName() - Method in class com.github.crob1140.confluence.spaces.Space

This method returns the name of the space.

getNumber() - Method in class com.github.crob1140.confluence.content.Version

This method returns the number of the version.

getPath() - Method in class com.github.crob1140.confluence.users.ProfilePicture

This method returns the path of the profile picture.

getPrefix() - Method in class com.github.crob1140.confluence.content.Label

This method returns the prefix of this label.

getProfilePicture() - Method in class com.github.crob1140.confluence.users.User

This method returns the profile picture of the user.

getProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedBodyFormatProperties

This method returns the set of properties that are to be expanded.

getProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildrenProperties

This method returns the set of properties that are to be expanded.

getProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedChildTypeProperties

This method returns the set of properties that are to be expanded.

getProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedContentProperties

This method returns the set of properties that are to be expanded.

getProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedDescendantsProperties

This method returns the set of properties that are to be expanded.

getProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedHistoryProperties

This method returns the set of properties that are to be expanded.

getProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedMetadataProperties

This method returns the set of properties that are to be expanded.

getProperties() - Method in class com.github.crob1140.confluence.content.expand.ExpandedRestrictionProperties

This method returns the set of properties that are to be expanded.

getQueryParams() - Method in class com.github.crob1140.confluence.requests.ConfluenceRequest

This method returns the query parameters for this request.

getQueryParams() - Method in class com.github.crob1140.confluence.requests.CreateContentRequest

This method returns the query parameters for this request.

getQueryParams() - Method in class com.github.crob1140.confluence.requests.GetContentRequest

This method returns the query parameters for this request.

getQueryParams() - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest

This method returns the query parameters for this request.

getRelativePath() - Method in class com.github.crob1140.confluence.requests.ConfluenceRequest

This method returns the path of the request relative to the Confluence wiki root.

getRelativePath() - Method in class com.github.crob1140.confluence.requests.CreateContentRequest

This method returns the path of the request relative to the Confluence wiki root.

getRelativePath() - Method in class com.github.crob1140.confluence.requests.GetContentRequest

This method returns the path of the request relative to the Confluence wiki root.

getRelativePath() - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest

This method returns the path of the request relative to the Confluence wiki root.

getResults() - Method in class com.github.crob1140.confluence.requests.GetContentResponse

This method returns the matching content contained in the response to a GetContentRequest.

getReturnType() - Method in class com.github.crob1140.confluence.requests.ConfluenceRequest

This method returns the class of the object in the body of the response for this request.

getReturnType() - Method in class com.github.crob1140.confluence.requests.CreateContentRequest

This method returns the class of the object in the body of the response for this request.

getReturnType() - Method in class com.github.crob1140.confluence.requests.GetContentRequest

This method returns the class of the object in the body of the response for this request.

getReturnType() - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest

This method returns the class of the object in the body of the response for this request.

getSpace() - Method in class com.github.crob1140.confluence.content.Content

This method returns the space that this content is in.

getStatus() - Method in class com.github.crob1140.confluence.content.Content

This method returns the status of the content.

getStatus() - Method in class com.github.crob1140.confluence.spaces.Space

This method returns the status of the space.

getStatusCode() - Method in exception com.github.crob1140.confluence.errors.ConfluenceRequestException

This method returns the HTTP status code returned with the error.

getStatusCode() - Method in class com.github.crob1140.confluence.errors.ErrorResponse

This method returns the HTTP status code of the error response.

getTitle() - Method in class com.github.crob1140.confluence.content.Content

This method returns the title of the content.

getTranslation() - Method in class com.github.crob1140.confluence.errors.ErrorMessage

This method returns the translation for the error message.

getType() - Method in class com.github.crob1140.confluence.content.Content

This method returns the type of the content.

getType() - Method in class com.github.crob1140.confluence.spaces.Space

This method returns the type of the space.

getType() - Method in class com.github.crob1140.confluence.users.User

This method returns the type of the user.

getUserKey() - Method in class com.github.crob1140.confluence.users.User

This method returns the key of the user.

getUsername() - Method in class com.github.crob1140.confluence.users.User

This method returns the username of the user.

getVersion() - Method in class com.github.crob1140.confluence.content.Content

This method returns the version of this content.

getVersion() - Method in class com.github.crob1140.confluence.content.Metadata

This method returns the version of the content corresponding to this metadata.

getWidth() - Method in class com.github.crob1140.confluence.users.ProfilePicture

This method returns the width of the profile picture, in pixels.

I

isAuthorized() - Method in class com.github.crob1140.confluence.errors.ErrorData

This method returns a flag indicating whether or not the request failed due to invalid.

isDefault() - Method in class com.github.crob1140.confluence.users.ProfilePicture

This method returns a flag indicating whether or not this is the default profile picture for the user.

isSuccessful() - Method in class com.github.crob1140.confluence.errors.ErrorData

This method returns a flag indicating whether or not the request completed successfully.

isValid() - Method in class com.github.crob1140.confluence.errors.ErrorData

This method returns a flag indicating whether or not the request was invalid.

L

Label - Class in com.github.crob1140.confluence.content

This class represents a label contained within an instance of Metadata.

Label(LabelPrefix, String) - Constructor for class com.github.crob1140.confluence.content.Label

This constructor creates a new label with the given prefix and name.

LabelPrefix - Enum in com.github.crob1140.confluence.content

This enumerable represents the possible values for the prefix in an instance of Label.

M

Metadata - Class in com.github.crob1140.confluence.content

This class represents the metadata for an instance of Content.

Metadata(List<Label>) - Constructor for class com.github.crob1140.confluence.content.Metadata

This constructor creates a metadata instance with only the labels defined.

O

orderBy(String, SortDirection) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the order-by clause for the query.

P

ProfilePicture - Class in com.github.crob1140.confluence.users

This class represents the profile picture for a User in the Confluence Cloud server.

ProfilePicture() - Constructor for class com.github.crob1140.confluence.users.ProfilePicture

S

setAncestor(String) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method sets the ancestor for the content by ID.

setAncestor(String) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method sets the ancestor for the content by ID.

setAncestors(List<Content>) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the ancestors of the content.

setBody(ContentBody) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the body of the content.

setBody(ContentBodyType, String) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method sets the body of the content.

setBody(ContentBodyType, String) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method sets the body of the content.

setExpandedProperties(ExpandedContentProperties) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the properties to be expanded in the results of this request.

setExpandedResponseProperties(ExpandedContentProperties) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method sets the properties to be expanded in the Content instance that is returned as a response to this request.

setId(String) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the unique identifier for the content.

setId(String) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method sets the unique identifier for the content.

setId(String) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method sets the unique identifier of the content to be updated.

setLimit(Integer) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the maximum number of results for the request.

setMetadata(Metadata) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the metadata of the content.

setPostingDay(LocalDate) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the required posting day for results.

setResponseStatusFilter(ContentStatus) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method sets the status filter for the Content that is returned as a response to the request.

setSpaceKey(String) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the space of the content by key.

setSpaceKey(String) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method sets the space that this content shall belong to by key.

setSpaceKey(String) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the space key for results.

setStartPosition(Integer) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the pagination start position for the request.

setStatus(ContentStatus) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the status of the content.

setStatus(ContentStatus) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method sets the status of the content.

setStatus(ContentStatus) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the required status for results.

setStatus(ContentStatus) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method sets the status of the content.

setTitle(String) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the title of the content.

setTitle(String) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method sets the title of the content.

setTitle(String) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This methods sets the required title for results.

setTitle(String) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method sets the title of the content.

setTrigger(String) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This methods sets the event to trigger as a result of this request.

setType(String) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the type of the content.

setType(StandardContentType) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the type of the content.

setType(String) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method defines the type of the content.

setType(StandardContentType) - Method in class com.github.crob1140.confluence.requests.CreateContentRequest.Builder

This method defines the type of the content.

setType(String) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the type of content to return.

setType(StandardContentType) - Method in class com.github.crob1140.confluence.requests.GetContentRequest.Builder

This method sets the type of content to return.

setType(String) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method defines the type of the content.

setType(StandardContentType) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method defines the type of the content.

setVersion(Version) - Method in class com.github.crob1140.confluence.content.Content.Builder

This method sets the version of the content.

setVersion(int) - Method in class com.github.crob1140.confluence.requests.UpdateContentRequest.Builder

This method sets the version number of the content.

SortDirection - Enum in com.github.crob1140.confluence.content

This enumerable represents the possible directions that can be used in an order-by clause

Space - Class in com.github.crob1140.confluence.spaces

This class represents a space in the Confluence Cloud server.

Space(String) - Constructor for class com.github.crob1140.confluence.spaces.Space

This constructor creates a space containing with only the key defined.

SpaceStatus - Enum in com.github.crob1140.confluence.spaces

This enumerable represents the possible values for the status of a Space instance.

SpaceType - Enum in com.github.crob1140.confluence.spaces

This enumerable represents the possible values for the type of a Space instance.

StandardContentType - Enum in com.github.crob1140.confluence.content

This enumerable represents the standard set of types that can be set on an instance of Content.

T

TokenAuth - Class in com.github.crob1140.confluence.auth

This class represents a token-based HTTP authentication scheme, such as JWT.

TokenAuth(String) - Constructor for class com.github.crob1140.confluence.auth.TokenAuth

This constructor creates a new instance of TokenAuth using the given token.

U

updateContent(UpdateContentRequest) - Method in class com.github.crob1140.confluence.ConfluenceClient

This method sends a request to the Confluence Cloud server to update content the content as defined in the given UpdateContentRequest.

UpdateContentRequest - Class in com.github.crob1140.confluence.requests

This class represents a request to update content in the Confluence Cloud server.

UpdateContentRequest.Builder - Class in com.github.crob1140.confluence.requests

This class can be used to construct an instance of UpdateContentRequest.

User - Class in com.github.crob1140.confluence.users

This class represents a user in the Confluence Cloud server.

User() - Constructor for class com.github.crob1140.confluence.users.User

UserType - Enum in com.github.crob1140.confluence.users

V

valueOf(String) - Static method in enum com.github.crob1140.confluence.content.ContentBodyType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.crob1140.confluence.content.ContentStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.crob1140.confluence.content.LabelPrefix

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.crob1140.confluence.content.SortDirection

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.crob1140.confluence.content.StandardContentType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.crob1140.confluence.spaces.SpaceStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.crob1140.confluence.spaces.SpaceType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.crob1140.confluence.users.UserType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.crob1140.confluence.content.ContentBodyType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.crob1140.confluence.content.ContentStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.crob1140.confluence.content.LabelPrefix

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.crob1140.confluence.content.SortDirection

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.crob1140.confluence.content.StandardContentType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.crob1140.confluence.spaces.SpaceStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.crob1140.confluence.spaces.SpaceType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.crob1140.confluence.users.UserType

Returns an array containing the constants of this enum type, in the order they are declared.

Version - Class in com.github.crob1140.confluence.content

This class represents a version information for an instance of Content.

Version(Integer) - Constructor for class com.github.crob1140.confluence.content.Version

This constructor creates a new instance with only the version number specified.

A B C E G I L M O P S T U V