Index (Support SDK

A B C D E F G H I L M N O P R S T U V W Z

A

ACTION_CONTACT_OPTION - Static variable in interface zendesk.support.Constants: Action string for Action Handlers which allow the user to contact
ACTION_DEFLECTION - Static variable in interface zendesk.support.Constants: Action string for an Action Handler which deflects requests
ACTION_REFRESH_REQUEST_CONVERSATION - Static variable in interface zendesk.support.Constants: Action string for refreshing the Request Conversation UI.
ACTION_REFRESH_REQUEST_LIST - Static variable in interface zendesk.support.Constants: Action string for refreshing the Request List UI.
addArticle(ArticleItem) - Method in class zendesk.support.SectionItem
addComment(String, EndUserComment, <any>) - Method in interface zendesk.support.RequestProvider: Add a EndUserComment to a request.
AgentInfo(String, String, String) - Constructor for class zendesk.support.requestlist.RequestInfo.AgentInfo
announceContentLoaded() - Method in class zendesk.support.guide.HelpCenterActivity
Article - Class in zendesk.support: This is a model class for an Article object that will be created by the HelpCenterProvider.
Article() - Constructor for class zendesk.support.Article
ARTICLE_VOTE_DOWN - Static variable in annotation type zendesk.support.SupportBlipsProvider.ArticleVote
ARTICLE_VOTE_UP - Static variable in annotation type zendesk.support.SupportBlipsProvider.ArticleVote
ArticleConfiguration - Class in zendesk.support.guide: Data class, that represents the initial configuration of ViewArticleActivity.
ArticleConfiguration.Builder - Class in zendesk.support.guide: This builder is used to generate an instance of ArticleConfiguration
ArticleItem - Class in zendesk.support: A HelpItem for Help Center articles
ArticleItem(Long, Long, String) - Constructor for class zendesk.support.ArticleItem
articleView(Article) - Method in interface zendesk.support.SupportBlipsProvider: Tracks a view of a Help Center article as a PageView blip.
articleVote(Long, int) - Method in interface zendesk.support.SupportBlipsProvider: Tracks a vote on a Help Center article as a UserAction blip.
ArticleVote - Class in zendesk.support: This is a class model for an Article vote.
ArticleVote() - Constructor for class zendesk.support.ArticleVote
ArticleVoteStorage - Interface in zendesk.support: Provides storage of an ArticleVote for each article with an article id.
Attachment - Class in zendesk.support: This is a model class for an Attachment object.
Attachment() - Constructor for class zendesk.support.Attachment
AttachmentFile - Class in zendesk.support: Model class representing a file to be uploaded to Zendesk Support as an attachment to a request comment.
AttachmentFile(String, String, File) - Constructor for class zendesk.support.AttachmentFile: Construct a new instance of an AttachmentFile with the provided file name, MIME type, and file.
AttachmentType - Enum in zendesk.support: Internal enum used to represent the allowed individual types of attachments that can be fetched from a Help Center instance.

B

build() - Method in class zendesk.support.HelpCenterSearch.Builder: Builds a HelpCenterSearch object with the specified parameters.
build() - Method in class zendesk.support.HelpRequest.Builder: Builds the HelpRequest request
build() - Method in class zendesk.support.SuggestedArticleSearch.Builder: Builds a HelpCenterSearch object with the specified parameters.
builder() - Static method in class zendesk.support.guide.HelpCenterActivity: Create a new builder for HelpCenterActivity.
builder() - Static method in class zendesk.support.guide.ViewArticleActivity: Create a new builder for ViewArticleActivity.
builder() - Static method in class zendesk.support.request.RequestActivity: Create a new builder for RequestActivity.
builder() - Static method in class zendesk.support.requestlist.RequestListActivity: Create a new builder for RequestListActivity.
builder(long) - Static method in class zendesk.support.guide.ViewArticleActivity: Create a new builder for ViewArticleActivity.
builder(Article) - Static method in class zendesk.support.guide.ViewArticleActivity: Create a new builder for ViewArticleActivity.
Builder() - Constructor for class zendesk.support.guide.ArticleConfiguration.Builder: Constructs an instance with a blank configuration
Builder() - Constructor for class zendesk.support.guide.HelpCenterConfiguration.Builder: Creates a new Builder.
Builder() - Constructor for class zendesk.support.HelpCenterSearch.Builder
Builder() - Constructor for class zendesk.support.HelpRequest.Builder
Builder() - Constructor for class zendesk.support.request.RequestConfiguration.Builder
Builder() - Constructor for class zendesk.support.requestlist.RequestListConfiguration.Builder
Builder() - Constructor for class zendesk.support.SuggestedArticleSearch.Builder
Builder(long) - Constructor for class zendesk.support.guide.ArticleConfiguration.Builder: Constructs an instance from the given articleId and title
Builder(Article) - Constructor for class zendesk.support.guide.ArticleConfiguration.Builder: Constructs an instance from the given article model

C

canHandle(String) - Method in class zendesk.support.CreateRequestActionHandler
Category - Class in zendesk.support: This is a model class for a Category object that will be created by the HelpCenterProvider.
Category() - Constructor for class zendesk.support.Category
CategoryItem - Class in zendesk.support: A HelpItem for Help Center categories
CategoryItem() - Constructor for class zendesk.support.CategoryItem
clearSearchResults() - Method in class zendesk.support.guide.HelpCenterActivity
Comment - Class in zendesk.support: This is a model class for a Comment object that will be created by the RequestProvider as part of CommentsResponse.
Comment() - Constructor for class zendesk.support.Comment
CommentResponse - Class in zendesk.support: This is a model class for a CommentResponse object that will be fetched by the RequestProvider as part of CommentsResponse.
CommentResponse() - Constructor for class zendesk.support.CommentResponse
CommentsResponse - Class in zendesk.support: This is a class model for a response for requesting comments for a request.
CommentsResponse() - Constructor for class zendesk.support.CommentsResponse
compareTo(FlatArticle) - Method in class zendesk.support.FlatArticle
config() - Method in class zendesk.support.guide.ArticleConfiguration.Builder: Create a Configuration for the passed in configuration options.
config() - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Create a Configuration for the passed in configuration options.
config() - Method in class zendesk.support.request.RequestConfiguration.Builder: Create a Configuration for the passed in configuration options.
config() - Method in class zendesk.support.requestlist.RequestListConfiguration.Builder: Create a Configuration for the passed in configuration options.
Constants - Interface in zendesk.support: Constants required for network operations
createRequest(CreateRequest, <any>) - Method in interface zendesk.support.RequestProvider: Calls a request service to create a request on behalf of the end-user.
CreateRequest - Class in zendesk.support: This is a model class for a request which will be created by the RequestProvider
CreateRequest() - Constructor for class zendesk.support.CreateRequest
CreateRequestActionHandler - Class in zendesk.support
CUSTOM_HC_CACHING_HEADER - Static variable in interface zendesk.support.Constants: Header name for the custom Help Center cache control header.
CustomField - Class in zendesk.support: CustomFields model which allows for custom data to be set on a request
CustomField(Long, Object) - Constructor for class zendesk.support.CustomField: Constructor for a custom field model to be included with a ticket

D

deepLinkIntent(Context, Intent...) - Method in class zendesk.support.request.RequestConfiguration.Builder: Creates and returns an Intent for starting a DeepLinkingBroadcastReceiver, for deep-linking to a RequestActivity.
deepLinkIntent(Context, List<Configuration>, Intent...) - Method in class zendesk.support.request.RequestConfiguration.Builder: Creates and returns an Intent for starting a DeepLinkingBroadcastReceiver, for deep-linking to a RequestActivity.
deleteAttachment(String, <any>) - Method in interface zendesk.support.UploadProvider: Calls a upload service to delete an upload on behalf of the end-user.
deleteVote(Long, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method will delete a vote with the given ID
Disk(Executor, Executor, SupportUiStorage, String) - Constructor for class zendesk.support.requestlist.RequestInfoDataSource.Disk
dismissError() - Method in class zendesk.support.guide.HelpCenterActivity
downvoteArticle(Long, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method marks as article as unhelpful

E

EndUserComment - Class in zendesk.support: EndUserComment object is used to model the difference the API for updating a Request has with fetching a list of Comments for a given request.
EndUserComment() - Constructor for class zendesk.support.EndUserComment
engine() - Static method in class zendesk.support.SupportEngine
equals(Object) - Method in class zendesk.support.ArticleItem
equals(Object) - Method in class zendesk.support.ArticleVote
equals(Object) - Method in class zendesk.support.CategoryItem
equals(Object) - Method in class zendesk.support.requestlist.RequestInfo.AgentInfo
equals(Object) - Method in class zendesk.support.requestlist.RequestInfo.MessageInfo
equals(Object) - Method in class zendesk.support.SectionItem
equals(Object) - Method in class zendesk.support.SeeAllArticlesItem
equals(Object) - Method in class zendesk.support.User
exitActivity() - Method in class zendesk.support.guide.HelpCenterActivity

F

FlatArticle - Class in zendesk.support: This is a model class for a FlatArticle object which contains an Article object, its relevant Section object and its relevant Category object for ease of use.
FlatArticle(Category, Section, Article) - Constructor for class zendesk.support.FlatArticle: Creates an instance of FlatArticle from the given category, section and article
forLocale(Locale) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the locale to perform the search in.
forLocale(Locale) - Method in class zendesk.support.SuggestedArticleSearch.Builder: Specifies the locale to perform the search in.

G

getActionDescription() - Method in class zendesk.support.CreateRequestActionHandler
getAllRequests(<any>) - Method in interface zendesk.support.RequestProvider: Gets all requests that user has opened.
getApiValue() - Method in enum zendesk.support.SortBy: Gets the value used by the API.
getApiValue() - Method in enum zendesk.support.SortOrder: This returns the value to use in an API call for this enum
getArticle() - Method in class zendesk.support.FlatArticle: The article object which this flat article is wrapping
getArticle() - Method in class zendesk.support.SearchArticle: Gets the wrapped Article object.
getArticle(Long, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method returns a single article from a Help Center instance based on the articleId provided
getArticleId() - Method in class zendesk.support.HelpCenterAttachment: Gets the ID of the Article that the attachment is associated with
getArticles(Long, <any>) - Method in interface zendesk.support.HelpCenterProvider: Fetch a list of articles for a given sectionId from a Help Center instance
getArticles(Long, String, <any>) - Method in interface zendesk.support.HelpCenterProvider: Fetch a list of articles for a given sectionId from a Help Center instance
getArticlesCount() - Method in class zendesk.support.Section: Gets the number of articles in this section
getArticlesPerPageLimit() - Method in class zendesk.support.HelpRequest: Gets the maximum number of articles per page
getAttachment() - Method in class zendesk.support.UploadResponse: Get a Attachment as a response of an uploaded file
getAttachments() - Method in class zendesk.support.Comment: Gets the attachments of the comment
getAttachments() - Method in class zendesk.support.CommentResponse: Gets the attachments of the comment
getAttachments() - Method in class zendesk.support.CreateRequest: Returns a List of attachment UploadResponse#tokens attached to the Request.
getAttachments() - Method in class zendesk.support.EndUserComment: Gets the attachments for this comment.
getAttachments(Long, AttachmentType, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method returns a list of attachments for a single article.
getAttachmentType() - Method in enum zendesk.support.AttachmentType: Gets the value that is used in the API to represent this attachment type
getAuthenticationType() - Method in class zendesk.support.SupportSdkSettings
getAuthor() - Method in class zendesk.support.Article: Gets the author of this article
getAuthorId() - Method in class zendesk.support.Article: Gets the ID of the author of the article
getAuthorId() - Method in class zendesk.support.Comment: Gets the ID of the author who created the comment.
getAuthorId() - Method in class zendesk.support.CommentResponse: Gets the ID of the author who created the comment.
getBody() - Method in class zendesk.support.Article: Gets the body of the article in plain text
getBody() - Method in class zendesk.support.Comment: Gets the body of the comment in plain text
getBody() - Method in class zendesk.support.CommentResponse: Gets the body of the comment in plain text
getCategories(<any>) - Method in interface zendesk.support.HelpCenterProvider: Fetch a list of categories from a Help Center instance.
getCategory() - Method in class zendesk.support.FlatArticle: Gets the category which this article belongs to
getCategory() - Method in class zendesk.support.SearchArticle: Gets the category that this article belongs in.
getCategory(Long, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method searches your Help Center instance for a category that matches the specified category ID.
getCategoryId() - Method in class zendesk.support.Section: Gets the id of the Category that this section belongs to
getCategoryId() - Method in class zendesk.support.SuggestedArticleSearch: Returns the category ID to specify
getCategoryIds() - Method in class zendesk.support.guide.HelpCenterConfiguration
getCategoryIds() - Method in class zendesk.support.HelpCenterSearch: Returns the category IDs to specify
getCategoryIds() - Method in class zendesk.support.HelpRequest: Gets the category IDs as a CSV string
getChildren() - Method in class zendesk.support.SectionItem
getCollaboratorIds() - Method in class zendesk.support.Request: Gets the IDs of all of the users who are collaborators on the Request
getCommentCount() - Method in class zendesk.support.Request: Gets the number of comments on the Request
getComments() - Method in class zendesk.support.CommentsResponse: Gets the comments in the response
getComments(String, <any>) - Method in interface zendesk.support.RequestProvider: Gets all comments for a request.
getCommentsSince(String, Date, boolean, <any>) - Method in interface zendesk.support.RequestProvider: Gets comments for a request since a specified point in time.
getConfigurations() - Method in class zendesk.support.guide.ArticleConfiguration
getConfigurations() - Method in class zendesk.support.guide.HelpCenterConfiguration
getConfigurations() - Method in class zendesk.support.request.RequestConfiguration
getConfigurations() - Method in class zendesk.support.requestlist.RequestListConfiguration
getContactZendeskTags() - Method in class zendesk.support.SupportSdkSettings: Gets the tags to use for the ContactZendesk components.
getContentType() - Method in class zendesk.support.Attachment: Gets the content type of the attachment, e.g.
getContentType() - Method in class zendesk.support.HelpCenterAttachment: Gets the content type of the attachment.
getContentUrl() - Method in class zendesk.support.Attachment: Gets the URL at which the attachment can be downloaded
getContentUrl() - Method in class zendesk.support.HelpCenterAttachment: Gets the URL which can be used to download the attachment
getContext() - Method in class zendesk.support.guide.HelpCenterActivity
getCount() - Method in class zendesk.support.ResponseWrapper: Gets the count of the resources in this response
getCreatedAt() - Method in class zendesk.support.Article: Gets the date that the article was created at.
getCreatedAt() - Method in class zendesk.support.ArticleVote: Gets the time at which the vote was created
getCreatedAt() - Method in class zendesk.support.Category: Gets the date that the category was created at.
getCreatedAt() - Method in class zendesk.support.Comment: Gets the date that the comment was created at
getCreatedAt() - Method in class zendesk.support.CommentResponse: Gets the date that the comment was created at
getCreatedAt() - Method in class zendesk.support.HelpCenterAttachment: Gets the date that the attachment was created at
getCreatedAt() - Method in class zendesk.support.Request: Gets the date that the Request was created at
getCreatedAt() - Method in class zendesk.support.Section: Gets the date that the section was created at
getCustomFields() - Method in class zendesk.support.CreateRequest
getCustomFields() - Method in class zendesk.support.Request: Gets the custom fields on the Request
getCustomFields() - Method in class zendesk.support.request.RequestConfiguration
getDescription() - Method in class zendesk.support.Category: Gets the description of the category
getDescription() - Method in class zendesk.support.CreateRequest: Gets the description of this request
getDescription() - Method in class zendesk.support.Request: Gets the description of the Request
getDescription() - Method in class zendesk.support.Section: Gets the description of the section
getDescription() - Method in class zendesk.support.TicketField: Gets the description of the ticket field.
getDownvoteCount() - Method in class zendesk.support.Article: Gets the number of downvotes for this article
getDueAt() - Method in class zendesk.support.Request: Gets the date that the Request is due at
getEngines() - Method in class zendesk.support.guide.ArticleConfiguration
getEngines() - Method in class zendesk.support.guide.HelpCenterConfiguration
getExpiresAt() - Method in class zendesk.support.UploadResponse: Gets the date that the token expires at
getFile() - Method in class zendesk.support.AttachmentFile
getFileName() - Method in class zendesk.support.Attachment: Gets the file name of the attachment
getFileName() - Method in class zendesk.support.AttachmentFile
getFileName() - Method in class zendesk.support.HelpCenterAttachment: Gets the filename of the attachment
getFiles() - Method in class zendesk.support.request.RequestConfiguration
getFilesAsAttachments() - Method in class zendesk.support.request.RequestConfiguration
getFirstComment() - Method in class zendesk.support.Request: Gets the first comment from the Request.
getHeight() - Method in class zendesk.support.Attachment: Gets the height of the attachment in pixels
getHelp(HelpRequest, <any>) - Method in interface zendesk.support.HelpCenterProvider: Gets a list of help items representing a flattened Help Center structure.
getHelpCenterLocale() - Method in class zendesk.support.SupportSdkSettings: Gets the default locale of the help center
getHelpCenterLocaleOverride() - Method in enum zendesk.support.Support: Returns the override, if any, for the locale to be used in Help Center requests.
getHtmlBody() - Method in class zendesk.support.Comment: Gets the HTML body of the comment
getHtmlBody() - Method in class zendesk.support.CommentResponse: Gets the HTML body of the comment
getHtmlUrl() - Method in class zendesk.support.Article: Gets the html URL of the article.
getHtmlUrl() - Method in class zendesk.support.Category: Gets the URL of the category that can be opened in a web browser
getHtmlUrl() - Method in class zendesk.support.Section: Gets the html URL of the section, which can be used to open the section in a web browser
getId() - Method in class zendesk.support.Article: Gets the ID of the article
getId() - Method in class zendesk.support.ArticleItem
getId() - Method in class zendesk.support.ArticleVote: Gets the ID of the Vote
getId() - Method in class zendesk.support.Attachment: Gets the ID of the attachment
getId() - Method in class zendesk.support.Category: Gets the ID of the category
getId() - Method in class zendesk.support.CategoryItem
getId() - Method in class zendesk.support.Comment: Gets the ID of the comment
getId() - Method in class zendesk.support.CommentResponse: Gets the ID of the comment
getId() - Method in class zendesk.support.CreateRequest: Gets the ID for this request
getId() - Method in class zendesk.support.CustomField
getId() - Method in class zendesk.support.HelpCenterAttachment: Gets the ID of the attachment
getId() - Method in interface zendesk.support.HelpItem: Gets the ID of this item.
getId() - Method in class zendesk.support.Organization: Gets the ID of the organization
getId() - Method in class zendesk.support.Request: Gets the ID of the Request
getId() - Method in class zendesk.support.Section: Gets the ID of the section
getId() - Method in class zendesk.support.SectionItem
getId() - Method in class zendesk.support.SeeAllArticlesItem
getId() - Method in class zendesk.support.SimpleArticle: Get the id of an article.
getId() - Method in class zendesk.support.SupportEngine
getId() - Method in class zendesk.support.SupportModule
getId() - Method in class zendesk.support.TicketField: Gets the ID of the ticket field.
getId() - Method in class zendesk.support.TicketFieldOption: Gets the ID of the ticket field option.
getId() - Method in class zendesk.support.TicketForm: Gets the ID of the ticket form.
getId() - Method in class zendesk.support.User: Get the id of the user.
getInclude() - Method in class zendesk.support.HelpCenterSearch: Returns the includes to specify.
getInclude() - Method in class zendesk.support.ListArticleQuery: Gets the includes for this query
getIncludes() - Method in class zendesk.support.HelpRequest: Gets the includes (side-loads) as a CSV string
getItemId() - Method in class zendesk.support.ArticleVote: Gets the id of the item for which the Vote was cast
getItemType() - Method in class zendesk.support.ArticleVote: Gets the type of the item.
getLabelNames() - Method in class zendesk.support.Article: Gets the label names of the article
getLabelNames() - Method in class zendesk.support.guide.HelpCenterConfiguration
getLabelNames() - Method in class zendesk.support.HelpCenterSearch: Returns the label names to specify.
getLabelNames() - Method in class zendesk.support.HelpRequest: Gets the label names to which the search will be restricted.
getLabelNames() - Method in class zendesk.support.ListArticleQuery: Gets the label names for this query as a CSV string
getLabelNames() - Method in class zendesk.support.SuggestedArticleSearch: Returns the label names to specify.
getLastComment() - Method in class zendesk.support.Request: Gets the last comment from the Request.
getLastCommentingAgents() - Method in class zendesk.support.Request: Gets the last 5 commenting agents.
getLocale() - Method in class zendesk.support.Article: Gets the locale of the article in the form of ll-CC, e.g.
getLocale() - Method in class zendesk.support.Category: Gets the locale of the category in the form of ll-CC, e.g.
getLocale() - Method in class zendesk.support.HelpCenterSearch: Returns the locale to search in
getLocale() - Method in class zendesk.support.HelpCenterSettings: Gets the locale that we should request Help Center content in by default.
getLocale() - Method in class zendesk.support.ListArticleQuery: Gets the locale for this query
getLocale() - Method in class zendesk.support.Section: Gets the locale of the section in the form of ll-CC, e.g.
getLocale() - Method in class zendesk.support.SuggestedArticleSearch: Returns the locale to search in.
getLocalRequestId() - Method in class zendesk.support.request.RequestConfiguration
getMaxAttachmentSize() - Method in class zendesk.support.SupportSdkSettings: Gets the maximum attachment size allowed in bytes
getMimeType() - Method in class zendesk.support.AttachmentFile
getName() - Method in class zendesk.support.ArticleItem
getName() - Method in class zendesk.support.Category: Gets the name of the category
getName() - Method in class zendesk.support.CategoryItem
getName() - Method in interface zendesk.support.HelpItem: Gets the name of the item
getName() - Method in class zendesk.support.Organization: Gets the name of the organization
getName() - Method in class zendesk.support.Section: Gets the name of the section
getName() - Method in class zendesk.support.SectionItem
getName() - Method in class zendesk.support.SeeAllArticlesItem
getName() - Method in class zendesk.support.TicketFieldOption: Gets the name of the ticket field option.
getName() - Method in class zendesk.support.TicketFieldSystemOption: Gets the name of the ticket field system option.
getName() - Method in class zendesk.support.TicketForm: Gets the name of the ticket form.
getName() - Method in class zendesk.support.User: Get the name of the user.
getNextPage() - Method in class zendesk.support.ResponseWrapper: Gets the API URL of the next page
getOrganizationId() - Method in class zendesk.support.Request: Gets the ID of the Organization that the Request is associated with
getOrganizationId() - Method in class zendesk.support.User: Get the organization id of the user.
getOrganizations() - Method in class zendesk.support.CommentsResponse: Gets the organizations that the users belong to
getPage() - Method in class zendesk.support.HelpCenterSearch: Returns the page to specify
getPage() - Method in class zendesk.support.ListArticleQuery: Gets the page for this query
getParentId() - Method in class zendesk.support.ArticleItem
getParentId() - Method in class zendesk.support.CategoryItem
getParentId() - Method in interface zendesk.support.HelpItem: Returns the ID of the parent item.
getParentId() - Method in class zendesk.support.SectionItem
getParentId() - Method in class zendesk.support.SeeAllArticlesItem
getPerPage() - Method in class zendesk.support.HelpCenterSearch: The amount of results per page to specify
getPhoto() - Method in class zendesk.support.User: Get avatar of the user.
getPosition() - Method in class zendesk.support.Category: Gets the position of the category.
getPosition() - Method in class zendesk.support.Section: Gets the sorting position of the section.
getPreviousPage() - Method in class zendesk.support.ResponseWrapper: Gets the API URL of the previous page
getPriority() - Method in class zendesk.support.CreateRequestActionHandler
getPriority() - Method in class zendesk.support.Request: Gets the priority of the Request
getPublicUpdatedAt() - Method in class zendesk.support.Request: Gets the date that the Request was publicly updated at
getQuery() - Method in class zendesk.support.HelpCenterSearch: Returns the free-form text query
getQuery() - Method in class zendesk.support.SuggestedArticleSearch: Returns the free-form text query.
getReferrerUrl() - Method in class zendesk.support.SupportSdkSettings: Gets the url that will be opened when referrer logo is clicked.
getRegexpForValidation() - Method in class zendesk.support.TicketField: Gets a regular expression for validation.
getRequest(String, <any>) - Method in interface zendesk.support.RequestProvider: Calls a request service to get a request for the given request id.
getRequesterId() - Method in class zendesk.support.Request: Gets the ID of the user who requested the Request
getRequestId() - Method in class zendesk.support.Comment: Gets the ID of the request that this comment belongs to
getRequestId() - Method in class zendesk.support.CommentResponse: Gets the ID of the request that this comment belongs to
getRequestId() - Method in class zendesk.support.request.RequestConfiguration
getRequests(String, <any>) - Method in interface zendesk.support.RequestProvider: Filters requests that user has opened by a status.
getRequestStatus() - Method in class zendesk.support.request.RequestConfiguration
getRequestSubject() - Method in class zendesk.support.request.RequestConfiguration
getRequestSystemMessage() - Method in class zendesk.support.SupportSdkSettings: Gets the system message that will be shown after the first message was successfully sent.
getRequestUpdates() - Method in class zendesk.support.RequestUpdates
getResults() - Method in class zendesk.support.SuggestedArticleResponse: Get a list of suggested articles.
getResultsPerPage() - Method in class zendesk.support.ListArticleQuery: Gets the results per page for this query
getSection() - Method in class zendesk.support.FlatArticle: Gets the section which this article belongs to
getSection() - Method in class zendesk.support.SearchArticle: Gets the section that this article belongs in.
getSection() - Method in class zendesk.support.SeeAllArticlesItem: Gets the SectionItem related to this SeeAllArticlesItem
getSection(Long, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method searches your Help Center instance for a section that matches the specified section ID.
getSectionId() - Method in class zendesk.support.Article: Gets the ID of the section that the article belongs to
getSectionId() - Method in class zendesk.support.SuggestedArticleSearch: Returns the section ID to specify
getSectionIds() - Method in class zendesk.support.guide.HelpCenterConfiguration
getSectionIds() - Method in class zendesk.support.HelpCenterSearch: Returns the section IDs to specify
getSectionIds() - Method in class zendesk.support.HelpRequest: Gets the section IDs as a CSV string
getSections() - Method in class zendesk.support.CategoryItem
getSections(Long, <any>) - Method in interface zendesk.support.HelpCenterProvider: Fetch a list of sections for a given categoryId from a Help Center instance
getSettings(<any>) - Method in interface zendesk.support.SupportSettingsProvider: Retrieves the SupportSettings wrapped in a SupportSdkSettings object.
getSize() - Method in class zendesk.support.Attachment: Gets the size of the attachment in bytes
getSize() - Method in class zendesk.support.HelpCenterAttachment: Gets the size of the attachment in bytes
getSortBy() - Method in class zendesk.support.ListArticleQuery: Gets the sort method for this query
getSorting() - Method in class zendesk.support.Section: Gets the sorting of the section, e.g.
getSortOrder() - Method in class zendesk.support.ListArticleQuery: Gets the sort order for this query
getSourceLocale() - Method in class zendesk.support.Article: Gets the source locale of the article in the form of ll-CC, e.g.
getSourceLocale() - Method in class zendesk.support.Category: Gets the source locale of the category in the form of ll-CC, e.g.
getSourceLocale() - Method in class zendesk.support.Section: Gets the source locale of the section in the form of ll-CC, e.g.
getStatus() - Method in class zendesk.support.Request: Gets the status of the Request
getStoredArticleVote(Long) - Method in interface zendesk.support.ArticleVoteStorage: Gets a stored ArticleVote from the device
getSubject() - Method in class zendesk.support.CreateRequest: Gets the subject of this request
getSubject() - Method in class zendesk.support.Request: Gets the subject of the Request
getSuggestedArticles(SuggestedArticleSearch, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method returns a list of suggested articles.
getTags() - Method in class zendesk.support.CreateRequest: Gets the tags for this request
getTags() - Method in class zendesk.support.request.RequestConfiguration
getTags() - Method in class zendesk.support.User: Gets the list of tags associated with the user
getThumbnails() - Method in class zendesk.support.Attachment: Gets the thumbnails of the attachment
getTicketFieldOptions() - Method in class zendesk.support.TicketField: Ticket field options, this field will only be populated for TicketFieldType.Tagger field types
getTicketFields() - Method in class zendesk.support.TicketForm: Gets a list of associated TicketField.
getTicketFieldSystemOptions() - Method in class zendesk.support.TicketField: Ticket field system options, this field will only be populated for TicketFieldType.Priority field types
getTicketForm() - Method in class zendesk.support.request.RequestConfiguration
getTicketFormId() - Method in class zendesk.support.CreateRequest
getTicketFormId() - Method in class zendesk.support.request.RequestConfiguration
getTicketFormsById(List<Long>, <any>) - Method in interface zendesk.support.RequestProvider: Get all available ticket forms.
getTitle() - Method in class zendesk.support.Article: Gets the title of the article
getTitle() - Method in class zendesk.support.SimpleArticle: Get the title of an article.
getTitle() - Method in class zendesk.support.TicketField: Gets the title of the ticket field.
getTitleInPortal() - Method in class zendesk.support.TicketField: Gets title of the ticket field for end user
getToken() - Method in class zendesk.support.UploadResponse: Gets the token associated with the uploaded file.
getTotalArticlesCount() - Method in class zendesk.support.SectionItem: Gets the number of articles in this SectionItem
getTransferOptionDescription() - Method in class zendesk.support.SupportEngine
getType() - Method in class zendesk.support.Request: Gets the type of the Request
getType() - Method in class zendesk.support.TicketField: Gets the type of the ticket field.
getUpdatedAt() - Method in class zendesk.support.Article: Gets the date that the article was updated at.
getUpdatedAt() - Method in class zendesk.support.ArticleVote: Gets the time at which the vote was updated
getUpdatedAt() - Method in class zendesk.support.Category: Gets the date that the category was updated at.
getUpdatedAt() - Method in class zendesk.support.HelpCenterAttachment: Gets the date that the attachment was updated at
getUpdatedAt() - Method in class zendesk.support.Request: Gets the date that the Request was updated at
getUpdatedAt() - Method in class zendesk.support.Section: Gets the date that the section was updated at
getUpdatesForDevice(<any>) - Method in interface zendesk.support.RequestProvider: Gets the details of any updates to requests for this device.
getUpvoteCount() - Method in class zendesk.support.Article: Gets the number of upvotes for this article.
getUrl() - Method in class zendesk.support.Article: Gets the API URL of the article
getUrl() - Method in class zendesk.support.ArticleVote: Gets the API URL of the Vote resource
getUrl() - Method in class zendesk.support.Attachment: Gets the API URL of the attachment
getUrl() - Method in class zendesk.support.Category: Gets the API URL of the category
getUrl() - Method in class zendesk.support.Comment: Gets the API URL of the comment
getUrl() - Method in class zendesk.support.CommentResponse: Gets the API URL of the comment
getUrl() - Method in class zendesk.support.HelpCenterAttachment: Gets the API URL of the attachment
getUrl() - Method in class zendesk.support.Request: Gets the API URL of the Request
getUrl() - Method in class zendesk.support.Section: Gets the API URL of the section
getUserFields() - Method in class zendesk.support.User: Get a map of user fields, associated with the user.
getUserId() - Method in class zendesk.support.ArticleVote: Gets the ID of the User who created the Vote
getUsers() - Method in class zendesk.support.CommentsResponse: Gets the users who made the comments in CommentsResponse.getComments()
getValue() - Method in class zendesk.support.ArticleVote: Gets the value of the Vote
getValue() - Method in class zendesk.support.CustomField: Deprecated.
use #getValueString()
As of 2.2.2 #value is of type Object, and may be a String, a Boolean, or a List This is to support multi-select custom fields. Use type specific getters for value, or use #getValueObject() to get the value as an object.
getValue() - Method in class zendesk.support.TicketFieldOption: Gets the value of the ticket field option.
getValue() - Method in class zendesk.support.TicketFieldSystemOption: Gets the value of the ticket field system option.
getValueBoolean() - Method in class zendesk.support.CustomField
getValueList() - Method in class zendesk.support.CustomField
getValueObject() - Method in class zendesk.support.CustomField
getValueString() - Method in class zendesk.support.CustomField
getViewType() - Method in class zendesk.support.ArticleItem
getViewType() - Method in class zendesk.support.CategoryItem
getViewType() - Method in interface zendesk.support.HelpItem: Gets the type of the item
getViewType() - Method in class zendesk.support.SectionItem
getViewType() - Method in class zendesk.support.SeeAllArticlesItem
getVoteCount() - Method in class zendesk.support.Article: Gets the total number of votes that have been cast for this article.
getVoteSum() - Method in class zendesk.support.Article: Gets the sum of votes.
getWidth() - Method in class zendesk.support.Attachment: Gets the width of the attachment in pixels

H

handle(Map<String, Object>, Context) - Method in class zendesk.support.CreateRequestActionHandler
hashCode() - Method in class zendesk.support.ArticleItem
hashCode() - Method in class zendesk.support.ArticleVote
hashCode() - Method in class zendesk.support.CategoryItem
hashCode() - Method in class zendesk.support.requestlist.RequestInfo.AgentInfo
hashCode() - Method in class zendesk.support.requestlist.RequestInfo.MessageInfo
hashCode() - Method in class zendesk.support.SectionItem
hashCode() - Method in class zendesk.support.SeeAllArticlesItem
hashCode() - Method in class zendesk.support.User
hasHelpCenterSettings() - Method in class zendesk.support.SupportSdkSettings: Checks if we have Help Center settings or not.
hasUpdatedRequests() - Method in class zendesk.support.RequestUpdates
HelpCenterActivity - Class in zendesk.support.guide: This Activity is the main entry point for showing Help Center content in the SDK.
HelpCenterActivity() - Constructor for class zendesk.support.guide.HelpCenterActivity
HelpCenterAttachment - Class in zendesk.support: This is a model class for an HelpCenterAttachment object that will be created by the HelpCenterProvider.
HelpCenterAttachment() - Constructor for class zendesk.support.HelpCenterAttachment
HelpCenterConfiguration - Class in zendesk.support.guide: Data class, that represents the initial configuration of HelpCenterActivity.
HelpCenterConfiguration.Builder - Class in zendesk.support.guide: This builder is used to generate the startup configuration for the Activity.
helpCenterProvider() - Method in interface zendesk.support.ProviderStore: Returns an implementation of HelpCenterProvider
HelpCenterProvider - Interface in zendesk.support: A provider which will offer a higher level of abstraction compared to the HelpCenterService.
helpCenterSearch(String) - Method in interface zendesk.support.SupportBlipsProvider: Tracks a Help Center search as a UserAction blip.
HelpCenterSearch - Class in zendesk.support: This class encapsulates the parameters for searching Help Center.
HelpCenterSearch.Builder - Class in zendesk.support: This is a builder class which is used to generate a HelpCenterSearch
HelpCenterSettings - Class in zendesk.support: Models the Help Center settings which will be used by the SupportActivity.
HelpItem - Interface in zendesk.support: Model representing items in the HelpCenter UI.
HelpRequest - Class in zendesk.support: Models a request for a flattened view of Help Center
HelpRequest.Builder - Class in zendesk.support: This builder is used to create a HelpRequest
hideLoadingState() - Method in class zendesk.support.guide.HelpCenterActivity
HOURS_MINUTES_FORMAT - Static variable in interface zendesk.support.Constants: Date format for displaying hours and minutes.

I

includeCategories() - Method in class zendesk.support.HelpRequest.Builder: Specifies that categories should be included as a side-load
includeSections() - Method in class zendesk.support.HelpRequest.Builder: Specifies that sections should be included as a side-load
init(Zendesk) - Method in enum zendesk.support.Support: Initialises the Zendesk SDK
insert(RequestInfo, <any>) - Method in class zendesk.support.requestlist.RequestInfoDataSource.LocalDataSource
intent(Context, Configuration...) - Method in class zendesk.support.guide.ArticleConfiguration.Builder: Create an Intent to start the ViewArticleActivity with the specified configuration options.
intent(Context, Configuration...) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Creates an Intent for the HelpCenterActivity with the specified configuration options.
intent(Context, Configuration...) - Method in class zendesk.support.request.RequestConfiguration.Builder: Create an Intent to start the RequestActivity with the specified configuration options.
intent(Context, Configuration...) - Method in class zendesk.support.requestlist.RequestListConfiguration.Builder: Create an Intent to start the RequestListActivity with the specified configuration options.
intent(Context, List<Configuration>) - Method in class zendesk.support.guide.ArticleConfiguration.Builder: Create an Intent to start the ViewArticleActivity with the specified configuration options.
intent(Context, List<Configuration>) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Creates an Intent for the HelpCenterActivity with the specified configuration options.
intent(Context, List<Configuration>) - Method in class zendesk.support.request.RequestConfiguration.Builder: Create an Intent to start the RequestActivity with the specified configuration options.
intent(Context, List<Configuration>) - Method in class zendesk.support.requestlist.RequestListConfiguration.Builder: Create an Intent to start the RequestListActivity with the specified configuration options.
isAgent() - Method in class zendesk.support.User: Is the user an agent.
isAttachmentsEnabled() - Method in class zendesk.support.SupportSdkSettings: Checks if attachments are enabled or not
isAvailable() - Method in class zendesk.support.TicketFormSettings: Determines whether TicketForms are available or not.
isCollapseCategories() - Method in class zendesk.support.guide.HelpCenterConfiguration
isCommentsDisabled() - Method in class zendesk.support.Article: Checks whether comments are disabled or not
isContactUsButtonVisible() - Method in class zendesk.support.guide.ArticleConfiguration
isContactUsButtonVisible() - Method in class zendesk.support.guide.HelpCenterConfiguration
isConversationOngoing() - Method in class zendesk.support.SupportEngine
isConversationsEnabled() - Method in class zendesk.support.SupportSdkSettings: Checks if conversations are enabled or not
isDefault() - Method in class zendesk.support.TicketFieldOption: Gets if the field is the default value.
isDraft() - Method in class zendesk.support.Article: Checks if the article is a draft or not
isExpanded() - Method in class zendesk.support.CategoryItem: Checks if the category is expanded
isHelpCenterArticleVotingEnabled() - Method in class zendesk.support.SupportSdkSettings: Checks if help center voting is enabled or not.
isHelpCenterEnabled() - Method in class zendesk.support.SupportSdkSettings: Checks if help center is enabled or not.
isInitialized() - Method in enum zendesk.support.Support: Gets whether Support.init(Zendesk) was called or not.
isLoading() - Method in class zendesk.support.SeeAllArticlesItem
isNeverAskForEmailEnabled() - Method in class zendesk.support.SupportSdkSettings: Checks if the SDK is allowed to ask the end-user for an email address if needed
isOutdated() - Method in class zendesk.support.Article: Checks whether the article is outdated or not
isOutdated() - Method in class zendesk.support.Category: Checks whether the category is outdated or not
isOutdated() - Method in class zendesk.support.Section: Checks whether the section is outdated or not
isPublic() - Method in class zendesk.support.Comment: Checks if this comment is public or not
isPublic() - Method in class zendesk.support.CommentResponse: Checks if this comment is public or not
isRequestUnread(String) - Method in class zendesk.support.RequestUpdates
isShowClosedRequests() - Method in class zendesk.support.SupportSdkSettings: Checks if the SDK is allowed to show closed requests in the RequestListView.
isShowConversationsMenuButton() - Method in class zendesk.support.guide.HelpCenterConfiguration
isShowingHelp() - Method in class zendesk.support.guide.HelpCenterActivity
isShowReferrerLogoEnabled() - Method in class zendesk.support.SupportSdkSettings: Checks if the SDK is allowed to display a referrer logo inside the RequestListView and RequestViewConversationsDisabled.
isTicketFormSupportAvailable() - Method in class zendesk.support.SupportSdkSettings: Gets if TicketForm support is available, or not.

L

ListArticleQuery - Class in zendesk.support: This class encapsulates the parameters for listing Articles in Help Center.
ListArticleQuery() - Constructor for class zendesk.support.ListArticleQuery
listArticles(ListArticleQuery, <any>) - Method in interface zendesk.support.HelpCenterProvider: Lists articles that match the parameters in the query.
listArticlesFlat(ListArticleQuery, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method returns a list of flatArticles which are objects containing an article, section and category all relevant to each other from a Help Center instance.
load(<any>) - Method in class zendesk.support.requestlist.RequestInfoDataSource.Disk
load(<any>) - Method in interface zendesk.support.requestlist.RequestInfoDataSource
load(<any>) - Method in class zendesk.support.requestlist.RequestInfoDataSource.LocalDataSource
load(<any>) - Method in class zendesk.support.requestlist.RequestInfoDataSource.Network
load(<any>) - Method in class zendesk.support.requestlist.RequestInfoDataSource.RemoteDataSource
load(<any>) - Method in class zendesk.support.requestlist.RequestInfoDataSource.Repository
LOCAL - Static variable in interface zendesk.support.requestlist.RequestInfoDataSource
LocalDataSource(RequestInfoDataSource.Disk) - Constructor for class zendesk.support.requestlist.RequestInfoDataSource.LocalDataSource

M

markRequestAsRead(String, int) - Method in interface zendesk.support.RequestProvider: Marks a request as read on this device.
markRequestAsUnread(String) - Method in interface zendesk.support.RequestProvider: Marks a request as unread on this device, by incrementing its total number of comments.
MessageInfo(String, Date, String) - Constructor for class zendesk.support.requestlist.RequestInfo.MessageInfo

N

NO_TICKET_FORM_ID - Static variable in class zendesk.support.request.RequestConfiguration: Sentinel value to represent the absence of a valid Ticket Form ID.

O

onBackPressed() - Method in class zendesk.support.request.RequestActivity
onCreate(Bundle) - Method in class zendesk.support.guide.HelpCenterActivity
onCreate(Bundle) - Method in class zendesk.support.guide.ViewArticleActivity
onCreate(Bundle) - Method in class zendesk.support.request.RequestActivity
onCreate(Bundle) - Method in class zendesk.support.requestlist.RequestListActivity
onCreateOptionsMenu(Menu) - Method in class zendesk.support.guide.HelpCenterActivity
onCreateOptionsMenu(Menu) - Method in class zendesk.support.request.RequestActivity
onDestroy() - Method in class zendesk.support.guide.ViewArticleActivity
onDestroy() - Method in class zendesk.support.requestlist.RequestListActivity
onEvent(Event) - Method in class zendesk.support.SupportEngine
onItemClick(<any>, View, int, long) - Method in class zendesk.support.guide.ViewArticleActivity
onOptionsItemSelected(MenuItem) - Method in class zendesk.support.guide.HelpCenterActivity
onOptionsItemSelected(MenuItem) - Method in class zendesk.support.guide.ViewArticleActivity
onOptionsItemSelected(MenuItem) - Method in class zendesk.support.request.RequestActivity
onPause() - Method in class zendesk.support.guide.HelpCenterActivity
onPause() - Method in class zendesk.support.request.RequestActivity
onPause() - Method in class zendesk.support.requestlist.RequestListActivity
onPrepareOptionsMenu(Menu) - Method in class zendesk.support.guide.HelpCenterActivity
onResume() - Method in class zendesk.support.guide.HelpCenterActivity
onResume() - Method in class zendesk.support.request.RequestActivity
onResume() - Method in class zendesk.support.requestlist.RequestListActivity
onSaveInstanceState(Bundle) - Method in class zendesk.support.request.RequestActivity
onStart() - Method in class zendesk.support.guide.HelpCenterActivity
onStart() - Method in class zendesk.support.guide.ViewArticleActivity
onStart() - Method in class zendesk.support.requestlist.RequestListActivity
onStop() - Method in class zendesk.support.guide.ViewArticleActivity
onStop() - Method in class zendesk.support.requestlist.RequestListActivity
Organization - Class in zendesk.support: This is a model class for a Organization object that will be created by the RequestProvider as part of CommentsResponse.
Organization() - Constructor for class zendesk.support.Organization

P

page(Integer) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies which page of results to request.
perPage(Integer) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the number of results to display per page
provider() - Method in enum zendesk.support.Support: Gets a ProviderStore for accessing all available SDK Providers.
ProviderStore - Interface in zendesk.support: Interface used to expose Providers through Support.

R

refresh(Context, ActionHandlerRegistry) - Static method in class zendesk.support.requestlist.RequestListActivity: Refresh this screen
refreshRequest(String, Context) - Method in enum zendesk.support.Support: Refreshes the Support SDK RequestActivity if it is currently being displayed (after Activity#onResume() but before Activity#onPause()) for the given request ID, or the RequestListActivity if it has not been destroyed (ie, by Activity#onDestroy().
REMOTE - Static variable in interface zendesk.support.requestlist.RequestInfoDataSource
remove(String, <any>) - Method in class zendesk.support.requestlist.RequestInfoDataSource.LocalDataSource
removeStoredArticleVote(Long) - Method in interface zendesk.support.ArticleVoteStorage: Removes an ArticleVote from the device
Request - Class in zendesk.support: This is a model class for a Request object that will be created by the RequestProvider.
Request() - Constructor for class zendesk.support.Request: Empty constructor for gson
RequestActivity - Class in zendesk.support.request: This Activity is the main entry point for showing and creating requests.
RequestActivity() - Constructor for class zendesk.support.request.RequestActivity
RequestConfiguration - Class in zendesk.support.request: Data class, that represents the initial configuration of RequestActivity.
RequestConfiguration.Builder - Class in zendesk.support.request
requestCreated(String) - Method in interface zendesk.support.SupportBlipsProvider: Tracks creation of a Support request as a UserAction blip.
RequestInfo.AgentInfo - Class in zendesk.support.requestlist
RequestInfo.MessageInfo - Class in zendesk.support.requestlist
RequestInfoDataSource - Interface in zendesk.support.requestlist
RequestInfoDataSource.Disk - Class in zendesk.support.requestlist
RequestInfoDataSource.LocalDataSource - Class in zendesk.support.requestlist
RequestInfoDataSource.Network - Class in zendesk.support.requestlist
RequestInfoDataSource.RemoteDataSource - Class in zendesk.support.requestlist
RequestInfoDataSource.Repository - Class in zendesk.support.requestlist
RequestListActivity - Class in zendesk.support.requestlist: This Activity is for showing a list of an end-user's requests
RequestListActivity() - Constructor for class zendesk.support.requestlist.RequestListActivity
RequestListConfiguration - Class in zendesk.support.requestlist: Data class, that represents the initial configuration of RequestListActivity.
RequestListConfiguration.Builder - Class in zendesk.support.requestlist
requestListViewed() - Method in interface zendesk.support.SupportBlipsProvider: Tracks a user's viewing of the request list as a UserAction blip.
requestProvider() - Method in interface zendesk.support.ProviderStore: Returns an implementation of RequestProvider
RequestProvider - Interface in zendesk.support: A provider which will offer a higher level of abstraction compared to the RequestService
You can create an instance of RequestProvider like this:
RequestStatus - Enum in zendesk.support
requestUpdated(String) - Method in interface zendesk.support.SupportBlipsProvider: Tracks a user's update of a Support request as a UserAction blip.
RequestUpdates - Class in zendesk.support
RequestUpdates(Map<String, Integer>) - Constructor for class zendesk.support.RequestUpdates
requestViewed(String) - Method in interface zendesk.support.SupportBlipsProvider: Tracks a user's viewing of a Support request as a UserAction blip.
ResponseWrapper - Class in zendesk.support: Wrapper class to encapsulate a generic response received from Zendesk service.
ResponseWrapper() - Constructor for class zendesk.support.ResponseWrapper

S

SDK_GUID_HEADER - Static variable in interface zendesk.support.Constants: Mobile-Sdk-Identity header name, used to convey identity information.
SearchArticle - Class in zendesk.support: This class will wrap a Article.
SearchArticle(Article, Section, Category) - Constructor for class zendesk.support.SearchArticle: Wraps an Article and also includes information of the location structure of the Article.
searchArticles(HelpCenterSearch, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method searches your Help Center instance for articles that match the specified parameters
Section - Class in zendesk.support: This is a model class for a Section object that will be created by the HelpCenterProvider.
Section() - Constructor for class zendesk.support.Section
SectionItem - Class in zendesk.support: A HelpItem for Help Center sections
SectionItem() - Constructor for class zendesk.support.SectionItem
SeeAllArticlesItem - Class in zendesk.support: A HelpItem for a 'See all articles' item
SeeAllArticlesItem(SectionItem) - Constructor for class zendesk.support.SeeAllArticlesItem
setAttachments(List<String>) - Method in class zendesk.support.Comment: Sets the attachments of the comment
setAttachments(List<String>) - Method in class zendesk.support.CreateRequest: Sets a List of attachment UploadResponse#token to this Request.
setAttachments(List<String>) - Method in class zendesk.support.EndUserComment: Sets the attachments for this comment
setAttachments(List<Attachment>) - Method in class zendesk.support.CommentResponse: Sets the attachments of the comment
setAuthor(User) - Method in class zendesk.support.Article: Sets the author of this article.
setAuthorId(Long) - Method in class zendesk.support.Comment: Sets the ID of the author who created the comment
setAuthorId(Long) - Method in class zendesk.support.CommentResponse: Sets the ID of the author who created the comment
setBody(String) - Method in class zendesk.support.Comment: Sets the body of the comment in plain text
setBody(String) - Method in class zendesk.support.CommentResponse: Sets the body of the comment in plain text
setComment(EndUserComment) - Method in class zendesk.support.Request: Sets the comment for the Request.
setCreatedAt(Date) - Method in class zendesk.support.Comment: Sets the date that the comment that the comment was created at
setCreatedAt(Date) - Method in class zendesk.support.CommentResponse: Sets the date that the comment that the comment was created at
setCustomFields(List<CustomField>) - Method in class zendesk.support.CreateRequest: Sets the custom fields for this Request.
setDescription(String) - Method in class zendesk.support.CreateRequest: Sets the description of this request
setExpanded(boolean) - Method in class zendesk.support.CategoryItem: Sets the expanded state.
setHelpCenterLocaleOverride(Locale) - Method in enum zendesk.support.Support: Set a locale override for Help Center content.
setId(Long) - Method in class zendesk.support.CommentResponse: Sets the id of the comment
setId(String) - Method in class zendesk.support.CreateRequest: Sets the ID for this request
setInclude(String) - Method in class zendesk.support.ListArticleQuery: Sets the includes for this query
setLabelNames(String) - Method in class zendesk.support.ListArticleQuery: Sets the label names to include in the query as a CSV string
setLoading(boolean) - Method in class zendesk.support.SeeAllArticlesItem
setLoadingState(ViewArticleActivity.LoadingState) - Method in class zendesk.support.guide.ViewArticleActivity: Sets the loading state of this fragment.
setLocale(Locale) - Method in class zendesk.support.ListArticleQuery: Sets the locale for this query
setMetadata(Map<String, String>) - Method in class zendesk.support.CreateRequest: Sets the metadata for this Request.
setPage(Integer) - Method in class zendesk.support.ListArticleQuery: Specifies the page for this query
setResultsPerPage(Integer) - Method in class zendesk.support.ListArticleQuery: Specifies the number of results per page for this query
setSearchEnabled(boolean) - Method in class zendesk.support.guide.HelpCenterActivity
setSections(List<SectionItem>) - Method in class zendesk.support.CategoryItem: Sets the sections to set as the children of the category
setSortBy(SortBy) - Method in class zendesk.support.ListArticleQuery: Sets the sort method for this query
setSortOrder(SortOrder) - Method in class zendesk.support.ListArticleQuery: Specifies the sort order for this query
setSubject(String) - Method in class zendesk.support.CreateRequest: Sets the subject of this request
setTags(List<String>) - Method in class zendesk.support.CreateRequest: Sets the tags for this request
setTicketFormId(Long) - Method in class zendesk.support.CreateRequest: Sets the ticket form id for this Request.
setValue(String) - Method in class zendesk.support.EndUserComment: Sets the value of this comment, e.g.
show(Context, Configuration...) - Method in class zendesk.support.guide.ArticleConfiguration.Builder: Shows the activity.
show(Context, Configuration...) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Starts the HelpCenterActivity.
show(Context, Configuration...) - Method in class zendesk.support.request.RequestConfiguration.Builder: Display RequestActivity to the user.
show(Context, Configuration...) - Method in class zendesk.support.requestlist.RequestListConfiguration.Builder: Show the RequestListActivity with the specified configuration options.
show(Context, List<Configuration>) - Method in class zendesk.support.guide.ArticleConfiguration.Builder: Shows the activity.
show(Context, List<Configuration>) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Starts the HelpCenterActivity.
show(Context, List<Configuration>) - Method in class zendesk.support.request.RequestConfiguration.Builder: Display RequestActivity to the user.
show(Context, List<Configuration>) - Method in class zendesk.support.requestlist.RequestListConfiguration.Builder: Show the RequestListActivity with the specified configuration options.
showContactUsButton() - Method in class zendesk.support.guide.HelpCenterActivity
showContactZendesk() - Method in class zendesk.support.guide.HelpCenterActivity
showContactZendesk() - Method in class zendesk.support.guide.ViewArticleActivity
showHelp(HelpCenterConfiguration) - Method in class zendesk.support.guide.HelpCenterActivity
showLoadArticleErrorWithRetry(HelpCenterMvp.ErrorType, RetryAction) - Method in class zendesk.support.guide.HelpCenterActivity
showLoadingErrorState(int) - Method in class zendesk.support.guide.ViewArticleActivity
showLoadingState() - Method in class zendesk.support.guide.HelpCenterActivity
showNoConnectionError() - Method in class zendesk.support.guide.HelpCenterActivity
showRequestList() - Method in class zendesk.support.guide.HelpCenterActivity
showSearchResults(List<SearchArticle>, String) - Method in class zendesk.support.guide.HelpCenterActivity
SimpleArticle - Class in zendesk.support: This is a model class for an simplified Article object that will be created by the HelpCenterProvider#getSuggestedArticles(SuggestedArticleSearch, ZendeskCallback).
SimpleArticle(Long, String) - Constructor for class zendesk.support.SimpleArticle: Initialise a SimpleArticle
SortBy - Enum in zendesk.support: This enum models the sorting types available in Help Center
SortOrder - Enum in zendesk.support: This enum models the sorting types available in Help Center
STANDARD_CACHING_HEADER - Static variable in interface zendesk.support.Constants: Header name for the standard cache control header.
start(MessagingApi) - Method in class zendesk.support.SupportEngine
stop() - Method in class zendesk.support.SupportEngine
storeArticleVote(Long, ArticleVote) - Method in interface zendesk.support.ArticleVoteStorage: Stores an ArticleVote on the device
Streams.Use<R,P extends java.io.Closeable> - Interface in zendesk.support: Function for working with Closeable types
submitRecordArticleView(Article, Locale, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method submits a record article view that is used for reporting.
SuggestedArticleResponse - Class in zendesk.support: Wrapper class to encapsulate a list SimpleArticle received from HelpCenterProvider#getSuggestedArticles(SuggestedArticleSearch, ZendeskCallback)
SuggestedArticleResponse() - Constructor for class zendesk.support.SuggestedArticleResponse
SuggestedArticleSearch - Class in zendesk.support: This class models a search for suggested articles
SuggestedArticleSearch.Builder - Class in zendesk.support: This is a builder class which is used to generate a SuggestedArticleSearch
Support - Enum in zendesk.support: Configuration class for Zendesk initialization.
SupportBlipsProvider - Interface in zendesk.support: A Provider for tracking user actions and page views.
SupportBlipsProvider.ArticleVote - Annotation Type in zendesk.support
SupportEngine - Class in zendesk.support
SupportModule - Class in zendesk.support: Module holding references to internal dependencies.
SupportModule(RequestProvider, UploadProvider, HelpCenterProvider, SupportSettingsProvider, SupportBlipsProvider, OkHttpClient, ZendeskTracker, ArticleVoteStorage) - Constructor for class zendesk.support.SupportModule
supportSdkInit() - Method in interface zendesk.support.SupportBlipsProvider: Tracks a Support SDK initialisation event as a UserAction blip.
SupportSdkSettings - Class in zendesk.support: Wraps SupportSettings and makes settings call null-safe.
SupportSdkSettings(SupportSettings, HelpCenterSettings, AuthenticationType) - Constructor for class zendesk.support.SupportSdkSettings: Creates an instance of SafeMobileSettings
SupportSettingsProvider - Interface in zendesk.support: This provider is used internally by the SDK and does not need to be called explicitly.

T

TicketField - Class in zendesk.support: Model class for ticket field.
TicketFieldOption - Class in zendesk.support: Model class for ticket field option.
TicketFieldSystemOption - Class in zendesk.support: Model class for ticket field system option.
TicketFieldType - Enum in zendesk.support: All supported ticket field types.
TicketForm - Class in zendesk.support: Model class for ticket forms.
TicketForm(long, String, List<TicketField>) - Constructor for class zendesk.support.TicketForm: Constructor for creating an instance of a ticket form.
TicketFormSettings - Class in zendesk.support: Models the TicketForm settings.
toString() - Method in class zendesk.support.FlatArticle
totalUpdates() - Method in class zendesk.support.RequestUpdates
TYPE_ARTICLE - Static variable in interface zendesk.support.HelpItem
TYPE_CATEGORY - Static variable in interface zendesk.support.HelpItem
TYPE_LOADING - Static variable in interface zendesk.support.HelpItem
TYPE_NO_RESULTS - Static variable in interface zendesk.support.HelpItem
TYPE_PADDING - Static variable in interface zendesk.support.HelpItem
TYPE_SECTION - Static variable in interface zendesk.support.HelpItem
TYPE_SEE_ALL - Static variable in interface zendesk.support.HelpItem

U

UiUtils.ScreenSize - Enum in zendesk.support
UNKNOWN_VOTE_COUNT - Static variable in class zendesk.support.Article
updateSettings(Map<String, JsonElement>) - Method in class zendesk.support.CreateRequestActionHandler
uploadAttachment(String, File, String, <any>) - Method in interface zendesk.support.UploadProvider: Calls a upload service to upload a file on behalf of the end-user.
uploadProvider() - Method in interface zendesk.support.ProviderStore: Returns an implementation of UploadProvider
UploadProvider - Interface in zendesk.support: A provider which will offer a higher level of abstraction compared to the UploadService
You can create an instance of UploadProvider like this:
UploadResponse - Class in zendesk.support: This is a class model for a response for an uploaded attachment.
UploadResponse() - Constructor for class zendesk.support.UploadResponse
upvoteArticle(Long, <any>) - Method in interface zendesk.support.HelpCenterProvider: This method marks as article as helpful
use(P) - Method in interface zendesk.support.Streams.Use
User - Class in zendesk.support: This is a model class for a user that will be created by the RequestProvider as part of CommentsResponse.
User() - Constructor for class zendesk.support.User: Initialises a user with default values.
User(Long, String, Attachment, boolean, Long, List<String>, Map<String, String>) - Constructor for class zendesk.support.User: Initialises a user with given values.
USER_AGENT_VARIANT - Static variable in interface zendesk.support.Constants: Header name for the standard cache control header.

V

valueOf(String) - Static method in enum zendesk.support.AttachmentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.support.RequestStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.support.SortBy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.support.SortOrder: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.support.Support: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.support.TicketFieldType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.support.UiUtils.ScreenSize: Returns the enum constant of this type with the specified name.
values() - Static method in enum zendesk.support.AttachmentType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.support.RequestStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.support.SortBy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.support.SortOrder: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.support.Support: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.support.TicketFieldType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.support.UiUtils.ScreenSize: Returns an array containing the constants of this enum type, in the order they are declared.
ViewArticleActivity - Class in zendesk.support.guide: Activity used to render a Help Center article
ViewArticleActivity() - Constructor for class zendesk.support.guide.ViewArticleActivity

W

withArticlesForCategoryIds(Long...) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies a startup configuration which will show articles for a given set of category IDs
withArticlesForCategoryIds(List<Long>) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies a startup configuration which will show articles for a given set of category IDs
withArticlesForSectionIds(Long...) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies a startup configuration which will show articles for a given set of section IDs
withArticlesForSectionIds(List<Long>) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies a startup configuration which will show articles for a given set of section IDs
withArticlesPerSectionLimit(int) - Method in class zendesk.support.HelpRequest.Builder: Specifies the maximum number of articles to request per section
withCategoriesCollapsed(boolean) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies whether or not to show all categories in the Help Center in their collapsed state when the content loads.
withCategoryId(Long) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the category id to restrict the results to.
withCategoryId(Long) - Method in class zendesk.support.SuggestedArticleSearch.Builder: Specifies the category id to restrict the results to.
withCategoryIds(List<Long>) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the category IDs to restrict the results to.
withCategoryIds(List<Long>) - Method in class zendesk.support.HelpRequest.Builder: Specifies the category IDs to include in the request
withContactUsButtonVisible(boolean) - Method in class zendesk.support.guide.ArticleConfiguration.Builder: Define which screens the "ContactUs" Floating Action Button should be shown on.
withContactUsButtonVisible(boolean) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Define whether or not to display the "ContactUs" Floating Action Button.
withContactUsButtonVisible(boolean) - Method in class zendesk.support.requestlist.RequestListConfiguration.Builder: Define whether or not to display the "ContactUs" Floating Action Button.
withCustomFields(List<CustomField>) - Method in class zendesk.support.request.RequestConfiguration.Builder: Attach a custom field form to the request.
withEngines(Engine...) - Method in class zendesk.support.guide.ArticleConfiguration.Builder: Specifies a list of Engines to be used to drive a follow up conversation if the user presses the contact FAB.
withEngines(Engine...) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies a list of Engines to be used to drive a follow up conversation if the user presses the contact FAB.
withEngines(List<Engine>) - Method in class zendesk.support.guide.ArticleConfiguration.Builder: Specifies a list of Engines to be used to drive a follow up conversation if the user presses the contact FAB.
withEngines(List<Engine>) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies a list of Engines to be used to drive a follow up conversation if the user presses the contact FAB.
withFiles(File...) - Method in class zendesk.support.request.RequestConfiguration.Builder: Specify File objects to be selected as an attachment to any requests created using this RequestConfiguration.
withFiles(List<File>) - Method in class zendesk.support.request.RequestConfiguration.Builder: Specify a list of File objects to be selected as attachments to any requests created using this RequestConfiguration.
withIncludes(String...) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the includes to be returned by the search.
withLabelNames(String...) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies a startup configuration which will restrict the shown articles to ones that match the provided label names.
withLabelNames(String...) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the label names to restrict the results to.
withLabelNames(String...) - Method in class zendesk.support.HelpRequest.Builder: Specifies the label names to which the search will be restricted.
withLabelNames(String...) - Method in class zendesk.support.SuggestedArticleSearch.Builder: Specifies the label names to restrict the results to.
withLabelNames(List<String>) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Specifies a startup configuration which will restrict the shown articles to ones that match the provided label names.
withQuery(String) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the free-form query to perform.
withQuery(String) - Method in class zendesk.support.HelpCenterSearch: Clones the current search and sets the query on it
withQuery(String) - Method in class zendesk.support.SuggestedArticleSearch.Builder: Specifies the free-form query to perform.
withRequest(Request) - Method in class zendesk.support.request.RequestConfiguration.Builder: Show an existing request.
withRequestId(String) - Method in class zendesk.support.request.RequestConfiguration.Builder: Show an existing request.
withRequestInfo(RequestInfo) - Method in class zendesk.support.request.RequestConfiguration.Builder
withRequestSubject(String) - Method in class zendesk.support.request.RequestConfiguration.Builder: Attach request subject to the created request
withSectionId(Long) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the section id to restrict the results to.
withSectionId(Long) - Method in class zendesk.support.SuggestedArticleSearch.Builder: Specifies the section id to restrict the results to.
withSectionIds(List<Long>) - Method in class zendesk.support.HelpCenterSearch.Builder: Specifies the section IDs to restrict the results to.
withSectionIds(List<Long>) - Method in class zendesk.support.HelpRequest.Builder: Specifies the section IDs to include in the request
withShowConversationsMenuButton(boolean) - Method in class zendesk.support.guide.HelpCenterConfiguration.Builder: Client-side API to specify whether or not to show the conversations button in the Toolbar of the HelpCenterActivity.
withTags(String...) - Method in class zendesk.support.request.RequestConfiguration.Builder: Attach tags to the created request.
withTags(List<String>) - Method in class zendesk.support.request.RequestConfiguration.Builder: Attach tags to the created request.
withTicketForm(long, List<CustomField>) - Method in class zendesk.support.request.RequestConfiguration.Builder: Attach a ticket form to the request.

Z

zendesk.support - package zendesk.support
zendesk.support.guide - package zendesk.support.guide
zendesk.support.request - package zendesk.support.request
zendesk.support.requestlist - package zendesk.support.requestlist

A B C D E F G H I L M N O P R S T U V W Z