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

A

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.

ActionHandler - Interface in zendesk.core

Defines a handler for an inter-SDK action, such as one SDK starting another one, without either SDK having a dependency on the other.

ActionHandlerRegistry - Interface in zendesk.core

Defines an interface for a registry of ActionHandler objects to be used for inter-SDK actions, such as starting an android.app.Activity from one SDK, in another SDK, without any dependency between them.

add(ActionHandler) - Method in interface zendesk.core.ActionHandlerRegistry

Adds an ActionHandler to the registry.

addArticle(ArticleItem) - Method in class zendesk.support.SectionItem

addComment(String, EndUserComment, <any>) - Method in interface zendesk.support.RequestProvider

Add a EndUserComment to a request.

addNetworkAwareListener(Integer, NetworkAware) - Method in interface zendesk.core.NetworkInfoProvider

Add a NetworkAware listener object, which will receive updates to the network state via NetworkAware.onNetworkAvailable() and NetworkAware.onNetworkUnavailable() as long as the NetworkInfoProvider is currently in a registered state.

addRetryAction(Integer, RetryAction) - Method in interface zendesk.core.NetworkInfoProvider

Add a RetryAction, whose RetryAction.onRetry() method will be called the next time the provider is notified with network availability.

addTags(List<String>, <any>) - Method in interface zendesk.core.UserProvider

Calls a user service to add tags to a user on behalf of the end-user.

AnonymousIdentity - Class in zendesk.core

This class models an identity which is used to identify an End User within a Zendesk instance.

AnonymousIdentity() - Constructor for class zendesk.core.AnonymousIdentity

Creates a new, empty instance of an AnonymousIdentity.

AnonymousIdentity.Builder - Class in zendesk.core

This is a builder class which is used to generate a Identity

ApplicationConfiguration - Class in zendesk.core

Class holding the minimum SDK configuration.

ApplicationConfiguration(String, String, String) - Constructor for class zendesk.core.ApplicationConfiguration

Create an instance of ApplicationConfiguration

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

ArticleItem - Class in zendesk.support

A HelpItem for Help Center articles

ArticleItem(Long, Long, String) - Constructor for class zendesk.support.ArticleItem

ArticleUiConfig - Class in zendesk.support.guide

Data class, that represents the initial configuration of ViewArticleActivity.

ArticleUiConfig.Builder - Class in zendesk.support.guide

This builder is used to generate an instance of ArticleUiConfig

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.core

This is a model class for an Attachment object.

Attachment - Class in zendesk.support

This is a model class for an Attachment object.

Attachment() - Constructor for class zendesk.core.Attachment

Attachment() - Constructor for class zendesk.support.Attachment

AttachmentSettings - Class in zendesk.support

These settings describe how attachments are handled in your Zendesk instance.

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.

AuthenticationProvider - Interface in zendesk.core

SDK access to Identity.

AuthenticationType - Enum in zendesk.core

Enum to track the authentication type for a given app configuration

B

BaseStorage - Interface in zendesk.core

Low level storage description.

BlipsGroup - Enum in zendesk.core

Defines the different groups of blips which can be sent.

BlipsProvider - Interface in zendesk.core

A Provider for tracking user actions.

build() - Method in class zendesk.core.AnonymousIdentity.Builder

Builds a Identity object with the specified parameters.

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 RequestActivity.

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, String) - Static method in class zendesk.support.guide.ViewArticleActivity

Create a new builder for RequestActivity.

builder(Article) - Static method in class zendesk.support.guide.ViewArticleActivity

Create a new builder for RequestActivity.

Builder() - Constructor for class zendesk.core.AnonymousIdentity.Builder

Creates a builder which can be used to create an anonymous identity

Builder() - Constructor for class zendesk.support.guide.ArticleUiConfig.Builder

Constructs an instance with a blank configuration

Builder() - Constructor for class zendesk.support.guide.HelpCenterUiConfig.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.RequestUiConfig.Builder

Builder() - Constructor for class zendesk.support.requestlist.RequestListUiConfig.Builder

Builder() - Constructor for class zendesk.support.SuggestedArticleSearch.Builder

Builder(long, String) - Constructor for class zendesk.support.guide.ArticleUiConfig.Builder

Constructs an instance from the given articleId and title

Builder(Article) - Constructor for class zendesk.support.guide.ArticleUiConfig.Builder

Constructs an instance from the given article model

C

canHandle(String) - Method in interface zendesk.core.ActionHandler

Determines whether or not the ActionHandler object can handle the given action String.

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

clear() - Method in interface zendesk.core.BaseStorage

Clear everything from storage.

clear() - Method in interface zendesk.core.MemoryCache

clear() - Method in interface zendesk.core.SessionStorage

Clear all session related data.

clearNetworkAwareListeners() - Method in interface zendesk.core.NetworkInfoProvider

Clear all added NetworkAware listener objects.

clearRetryActions() - Method in interface zendesk.core.NetworkInfoProvider

Clear all added RetryAction objects.

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.ArticleUiConfig.Builder

Create a UiConfig for the passed in configuration options.

config() - Method in class zendesk.support.guide.HelpCenterUiConfig.Builder

Create a UiConfig for the passed in configuration options.

config() - Method in class zendesk.support.request.RequestUiConfig.Builder

Create a UiConfig for the passed in configuration options.

config() - Method in class zendesk.support.requestlist.RequestListUiConfig.Builder

Create a UiConfig for the passed in configuration options.

configureOkHttpClient(OkHttpClient.Builder) - Method in class zendesk.core.CustomNetworkConfig

Add custom configuration to the OkHttpClient.Builder which will be used by the object returned by RestServiceProvider.createRestService(Class, CustomNetworkConfig).

configureRetrofit(Retrofit.Builder) - Method in class zendesk.core.CustomNetworkConfig

Add custom configuration to the Retrofit.Builder which will be used by the object returned by RestServiceProvider.createRestService(Class, CustomNetworkConfig).

Constants - Interface in zendesk.support

Constants required for network operations

ContactUsSettings - Class in zendesk.support

Models the Request settings which will be used by the ContactZendeskActivity or the ContactZendeskFragment.

contains(String) - Method in interface zendesk.core.MemoryCache

ConversationsSettings - Class in zendesk.support

Models the Conversations settings which will be used by the RequestActivity or the RequestListActivity.

coreModule() - Method in enum zendesk.core.Zendesk

For internal use.

CoreModule - Class in zendesk.core

Module holding references to internal dependencies.

CoreSettings - Class in zendesk.core

This model contains the server-driven core SDK specific configurations that can affect how the SDK behaves.

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

createRestService(Class<E>) - Method in interface zendesk.core.RestServiceProvider

Create a RestApi from the provided class.

createRestService(Class<E>, CustomNetworkConfig) - Method in interface zendesk.core.RestServiceProvider

Create a RestApi from the provided class, with a configuration class for custom network needs.

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, String) - Constructor for class zendesk.support.CustomField

Constructor for a custom field model to be included with a ticket

CustomNetworkConfig - Class in zendesk.core

Abstract class for customising network configuration, to be used by Zendesk SDKs in conjunction with RestServiceProvider.createRestService(Class, CustomNetworkConfig).

CustomNetworkConfig() - Constructor for class zendesk.core.CustomNetworkConfig

D

deepLinkIntent(Context, Intent...) - Method in class zendesk.support.request.RequestUiConfig.Builder

Creates and returns an Intent for starting a DeepLinkingBroadcastReceiver, for deep-linking to a RequestActivity.

defaultSettings() - Static method in class zendesk.support.HelpCenterSettings

defaultSettings() - Static method in class zendesk.support.SupportSettings

deleteAttachment(String, <any>) - Method in interface zendesk.support.UploadProvider

Calls a upload service to delete an upload on behalf of the end-user.

deleteTags(List<String>, <any>) - Method in interface zendesk.core.UserProvider

Calls a user service to remove tags from a user 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 As of 1.6.0.1, the Callback is of `Void` type.

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

equals(Object) - Method in class zendesk.core.AnonymousIdentity

equals(Object) - Method in class zendesk.core.ApplicationConfiguration

equals(Object) - Method in class zendesk.core.JwtIdentity

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.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

findHandlerByAction(String) - Method in interface zendesk.core.ActionHandlerRegistry

Finds and returns the highest priority ActionHandler whose ActionHandler.canHandle(String) method returned true for the given action String, or null if no ActionHandlers returned true.

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 easy 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

get(String) - Method in interface zendesk.core.BaseStorage

Retrieve the stored value for the provided key.

get(String) - Method in interface zendesk.core.MemoryCache

get(String, Class<E>) - Method in interface zendesk.core.BaseStorage

Retrieve the stored value for the provided key.

getAction() - Method in class zendesk.core.UserAction

getAdditionalSdkStorage() - Method in interface zendesk.core.SessionStorage

Gets a reference to additional sdk storage

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

getApplicationId() - Method in class zendesk.core.ApplicationConfiguration

Gets the App ID

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.EndUserComment

Gets the attachments for this comment.

getAttachments() - Method in class zendesk.support.SupportSettings

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

getAuthentication() - Method in class zendesk.core.CoreSettings

Returns the authentication type enabled for the App configuration

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.core.UserAction

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.HelpCenterUiConfig

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

getChannel() - Method in class zendesk.core.PageView

getChannel() - Method in class zendesk.core.UserAction

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.

getContactUs() - Method in class zendesk.support.SupportSettings

getContactZendeskTags() - Method in class zendesk.support.SupportSdkSettings

Gets the tags to use for the ContactZendesk components.

getContentType() - Method in class zendesk.core.Attachment

Gets the content type of the attachment, e.g.

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.core.Attachment

Gets the URL at which the attachment can be downloaded

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

getConversations() - Method in class zendesk.support.SupportSettings

getCoreSettings() - Method in class zendesk.core.SettingsPack

Gets core settings

getCoreSettings(<any>) - Method in interface zendesk.core.SdkSettingsProvider

Retrieves core settings from storage if they are valid or network if they are not.

getCount() - Method in class zendesk.support.ResponseWrapper

Gets the count of the resources in this response

getCreatedAt() - Method in class zendesk.core.UserField

Gets the date that the user field was created at

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 enum zendesk.support.Support

Gets the custom fields

getDescription() - Method in class zendesk.core.UserField

Get the description of the user field.

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

getEmail() - Method in class zendesk.core.AnonymousIdentity

Gets the email address associated with this anonymous identity

getExpiresAt() - Method in class zendesk.support.UploadResponse

Gets the date that the token expires at

getFileName() - Method in class zendesk.core.Attachment

Gets the file name of the attachment

getFileName() - Method in class zendesk.support.Attachment

Gets the file name of the attachment

getFileName() - Method in class zendesk.support.HelpCenterAttachment

Gets the filename of the attachment

getFiles() - Method in class zendesk.support.request.RequestUiConfig

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

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.core.Attachment

Gets the ID of the attachment

getId() - Method in class zendesk.core.User

Get the id of the user.

getId() - Method in class zendesk.core.UserField

Get the id of the user field.

getId() - Method in class zendesk.core.UserFieldOption

Get the id of the user field option.

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.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.

getIdentity() - Method in interface zendesk.core.AuthenticationProvider

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.

getJwtUserIdentifier() - Method in class zendesk.core.JwtIdentity

Gets the JWT User Identifier

getKey() - Method in class zendesk.core.UserField

Get the unique key of the user field.

getLabel() - Method in class zendesk.core.UserAction

getLabelNames() - Method in class zendesk.support.Article

Gets the label names of the article

getLabelNames() - Method in class zendesk.support.guide.HelpCenterUiConfig

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.RequestUiConfig

getMaxAttachmentSize() - Method in class zendesk.support.AttachmentSettings

This setting controls the maximum attachment size that can be uploaded to your Zendesk.

getMaxAttachmentSize() - Method in class zendesk.support.SupportSdkSettings

Gets the maximum attachment size allowed in bytes

getMediaOkHttpClient() - Method in interface zendesk.core.RestServiceProvider

Gets an OkHttpClient that's doing zendesk auth and is heavily caching responses.

getName() - Method in class zendesk.core.AnonymousIdentity

Gets the name associated with this anonymous identity

getName() - Method in class zendesk.core.User

Get the name of the user.

getName() - Method in class zendesk.core.UserFieldOption

Get the name of the user field option.

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.TicketForm

Gets the name of the ticket form.

getName() - Method in class zendesk.support.User

Get the name of the user.

getNavigatorLanguage() - Method in class zendesk.core.PageView

getNextPage() - Method in class zendesk.support.ResponseWrapper

Gets the API URL of the next page

getOauthClientId() - Method in class zendesk.core.ApplicationConfiguration

Gets an Oauth client id

getOrDefault(String, T) - Method in interface zendesk.core.MemoryCache

getOrganizationId() - Method in class zendesk.core.User

Get the organization id of the user.

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

getPageTitle() - Method in class zendesk.core.PageView

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.core.User

Get avatar of the user.

getPhoto() - Method in class zendesk.support.User

Get avatar of the user.

getPosition() - Method in class zendesk.core.UserField

Gets the position of the user field

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 interface zendesk.core.ActionHandler

Returns the priority of the ActionHandler.

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.LastSearch

Gets the query terms of the last search

getQuery() - Method in class zendesk.support.SuggestedArticleSearch

Returns the free-form text query.

getRawDescription() - Method in class zendesk.core.UserField

Get the raw description of the user field.

getRawName() - Method in class zendesk.core.UserFieldOption

Gets the raw name of the user field option

getRawTitle() - Method in class zendesk.core.UserField

Gets the raw title of the user field

getReferrerUrl() - Method in class zendesk.support.SupportSdkSettings

Gets the url that will be opened when referrer logo is clicked.

getReferrerUrl() - Method in class zendesk.support.SupportSettings

getRegexpForValidation() - Method in class zendesk.core.UserField

Gets the regexp which is used to validate the user field

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.RequestUiConfig

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.RequestUiConfig

getRequestSubject() - Method in class zendesk.support.request.RequestUiConfig

getRequestUpdates() - Method in class zendesk.support.RequestUpdates

getResults() - Method in class zendesk.support.SuggestedArticleResponse

Get a list of suggested articles.

getResultsCount() - Method in class zendesk.support.LastSearch

Gets the number of results that the last search had

getResultsPerPage() - Method in class zendesk.support.ListArticleQuery

Gets the results per page for this query

getSdkGuid() - Method in class zendesk.core.AnonymousIdentity

Gets the sdk guid associated with this anonymous identity

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.HelpCenterUiConfig

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() - Method in class zendesk.core.SettingsPack

Gets settings of the specified type.

getSettings(<any>) - Method in interface zendesk.support.SupportSettingsProvider

Retrieves the SupportSettings wrapped in a SupportSdkSettings object.

getSettingsForSdk(String, Class<E>, <any>) - Method in interface zendesk.core.SdkSettingsProvider

Retrieves SDK-specific settings and Core settings in a SettingsPack object.

getSize() - Method in class zendesk.core.Attachment

Gets the size of the attachment in bytes

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.

getSupportModule() - Method in enum zendesk.support.Support

Only for internal use.

getTags() - Method in class zendesk.core.User

Gets the list of tags associated with the user

getTags() - Method in class zendesk.support.ContactUsSettings

Gets a list of tags that will be appended to the ticket that is created by the contact Zendesk component.

getTags() - Method in class zendesk.support.CreateRequest

Gets the tags for this request

getTags() - Method in class zendesk.support.request.RequestUiConfig

getTags() - Method in class zendesk.support.User

Gets the list of tags associated with the user

getThumbnails() - Method in class zendesk.core.Attachment

Gets the thumbnails of the attachment

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.

getTicketForm() - Method in class zendesk.support.request.RequestUiConfig

getTicketFormId() - Method in class zendesk.support.CreateRequest

getTicketFormId() - Method in enum zendesk.support.Support

Gets the ticket form Id

getTicketForms() - Method in class zendesk.support.SupportSettings

getTicketFormsById(List<Long>, <any>) - Method in interface zendesk.support.RequestProvider

Get all available ticket forms.

getTitle() - Method in class zendesk.core.UserField

Get the title of the user field.

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.

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

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.

getUiConfigs() - Method in class zendesk.support.guide.ArticleUiConfig

getUiConfigs() - Method in class zendesk.support.guide.HelpCenterUiConfig

getUiConfigs() - Method in class zendesk.support.request.RequestUiConfig

getUiConfigs() - Method in class zendesk.support.requestlist.RequestListUiConfig

getUiConfigs() - Method in interface zendesk.support.UiConfig

A list of configurations that gets passed through screens and is used for configuring activities that get started from the initial entry point.

getUpdatedAt() - Method in class zendesk.core.UserField

Gets the date that the user field was updated at

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.core.Attachment

Gets the API URL of the attachment

getUrl() - Method in class zendesk.core.PageView

getUrl() - Method in class zendesk.core.UserField

Gets the API URL of the user field

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

getUser(<any>) - Method in interface zendesk.core.UserProvider

Calls a user service to get information about the current logged in user.

getUserFieldOptions() - Method in class zendesk.core.UserField

Get a list of UserFieldOption.

getUserFields() - Method in class zendesk.core.User

Get a map of user fields, associated with the user.

getUserFields() - Method in class zendesk.support.User

Get a map of user fields, associated with the user.

getUserFields(<any>) - Method in interface zendesk.core.UserProvider

Gets a list of user field definitions that are available in your account.

getUserFieldType() - Method in class zendesk.core.UserField

Get the type of the user field.

getUserId() - Method in class zendesk.support.ArticleVote

Gets the ID of the com.zendesk.sdk.model.helpcenter.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.core.PageView

getValue() - Method in class zendesk.core.UserAction

getValue() - Method in class zendesk.core.UserFieldOption

Get the value of the user field options.

getValue() - Method in class zendesk.support.ArticleVote

Gets the value of the Vote

getValue() - Method in class zendesk.support.CustomField

getValue() - Method in class zendesk.support.TicketFieldOption

Gets the value of the ticket field option.

getVersion() - Method in class zendesk.core.PageView

getVersion() - Method in class zendesk.core.UserAction

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

getZendeskCacheDir() - Method in interface zendesk.core.SessionStorage

Gets the absolute path to Core SDK specific cache directory.

getZendeskDataDir() - Method in interface zendesk.core.SessionStorage

Gets the absolute path to Core SDK specific data directory.

getZendeskUrl() - Method in class zendesk.core.ApplicationConfiguration

Gets the configured zendesk url

H

handle(Map<String, Object>, Context) - Method in interface zendesk.core.ActionHandler

Invokes an action on the given action String.

hashCode() - Method in class zendesk.core.AnonymousIdentity

hashCode() - Method in class zendesk.core.ApplicationConfiguration

hashCode() - Method in class zendesk.core.JwtIdentity

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.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

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.

HelpCenterUiConfig - Class in zendesk.support.guide

Data class, that represents the initial configuration of HelpCenterActivity.

HelpCenterUiConfig.Builder - Class in zendesk.support.guide

This builder is used to generate the startup configuration for the Activity.

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

Identity - Interface in zendesk.core

This is a marker interface for handling different identity types which are used to resolve end users within a Zendesk instance.

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(Context, String, String, String, Identity) - Method in enum zendesk.core.Zendesk

Initialises the Zendesk Core SDK with your Zendesk subdomain settings and an Identity.

init(Zendesk) - Method in enum zendesk.support.Support

Initialises the Zendesk SDK

intent(Context) - Method in class zendesk.support.guide.ArticleUiConfig.Builder

Create an Intent to start the ViewArticleActivity with the specified configuration options.

intent(Context) - Method in class zendesk.support.guide.HelpCenterUiConfig.Builder

Creates an Intent for the HelpCenterActivity with the specified configuration options.

intent(Context) - Method in class zendesk.support.request.RequestUiConfig.Builder

Create an Intent to start the RequestActivity with the specified configuration options.

intent(Context) - Method in class zendesk.support.requestlist.RequestListUiConfig.Builder

Create an Intent to start the RequestListActivity with the specified configuration options.

isActive() - Method in class zendesk.core.UserField

Checks if the user field is active or not

isAgent() - Method in class zendesk.core.User

Is the user an agent.

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.HelpCenterUiConfig

isCommentsDisabled() - Method in class zendesk.support.Article

Checks whether comments are disabled or not

isContactUsButtonVisible() - Method in class zendesk.support.guide.HelpCenterUiConfig

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

isEnabled() - Method in class zendesk.support.AttachmentSettings

This setting corresponds to the "Customers can attach files" setting in the Zendesk admin interface.

isEnabled() - Method in class zendesk.support.ConversationsSettings

Determines whether the Conversations feature should be enabled or not.

isEnabled() - Method in class zendesk.support.HelpCenterSettings

Determines whether the Help Center feature is enabled or not.

isExpanded() - Method in class zendesk.support.CategoryItem

Checks if the category is expanded

isHelpCenterEnabled() - Method in class zendesk.support.SupportSdkSettings

Checks if help center is enabled or not.

isInitialized() - Method in enum zendesk.core.Zendesk

Gets whether Zendesk.init(Context, String, String, String, Identity) was called with valid values 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

isNetworkAvailable() - Method in interface zendesk.core.NetworkInfoProvider

Returns whether or not the network is currently available.

isNeverAskForEmailEnabled() - Method in class zendesk.support.SupportSdkSettings

Checks if the SDK is allowed to ask the end-user for an email address if needed

isNeverRequestEmailOn() - Method in class zendesk.support.SupportSettings

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

isRegisteredForPush() - Method in interface zendesk.core.PushRegistrationProvider

Returns whether or not the device is currently registered for push notifications.

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.

isShowClosedRequests() - Method in class zendesk.support.SupportSettings

isShowConversationsMenuButton() - Method in class zendesk.support.guide.HelpCenterUiConfig

isShowingHelp() - Method in class zendesk.support.guide.HelpCenterActivity

isShowReferrerLogo() - Method in class zendesk.support.SupportSettings

isShowReferrerLogoEnabled() - Method in class zendesk.support.SupportSdkSettings

Checks if the SDK is allowed to display a referrer logo inside the RequestListView and RequestViewConversationsDisabled.

isSystem() - Method in class zendesk.core.UserField

Checks if the user field is a system field or not

isTicketFormSupportAvailable() - Method in class zendesk.support.SupportSdkSettings

Gets if TicketForm support is available, or not.

J

JwtIdentity - Class in zendesk.core

This class models a JWT identity which is used to identify an End User within a Zendesk instance.

JwtIdentity(String) - Constructor for class zendesk.core.JwtIdentity

Creates a JWT identity that will be used during identification of a user.

L

LastSearch - Class in zendesk.support

This class encapsulates information about the last Help Center search.

LastSearch(String, int) - Constructor for class zendesk.support.LastSearch

Creates an instance of LastSearch from the given query and result count

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.

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.

MemoryCache - Interface in zendesk.core

Cache for storing data at the application level to survive config changes, prevents pollution of the parcelable buffers when handing larger objects.

N

NetworkAware - Interface in zendesk.core

Interface to indicate that an implementer is aware of changes to network state

NetworkInfoProvider - Interface in zendesk.core

A provider which will provide information about network connectivity.

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

onItemClick(<any>, View, int, long) - Method in class zendesk.support.guide.ViewArticleActivity

onNetworkAvailable() - Method in interface zendesk.core.NetworkAware

Called when network connectivity is available

onNetworkUnavailable() - Method in interface zendesk.core.NetworkAware

Called when network connectivity is unavailable.

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

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

onRetry() - Method in interface zendesk.core.RetryAction

Called when actions should be retried

onSaveInstanceState(Bundle) - Method in class zendesk.support.request.RequestActivity

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

overwriteIdentity(Identity) - Method in enum zendesk.core.Zendesk

Overwrites the current identity which the SDK uses to access and create resources, at runtime, if the Identity provided in Zendesk.init(Context, String, String, String, Identity) (or the last time overwriteIdentity(Identity) was called) is no longer the desired user identity.

P

page(Integer) - Method in class zendesk.support.HelpCenterSearch.Builder

Specifies which page of results to request.

PageView - Class in zendesk.core

Model class for BlipsPageView used in BlipsProvider.sendBlip(BlipsGroup, PageView).

PageView(String, String, String, String, String) - Constructor for class zendesk.core.PageView

PageView(String, String, String, String, String, Map<String, Object>) - Constructor for class zendesk.core.PageView

parse(HttpUrl) - Method in interface zendesk.support.ZendeskDeepLinkParser.Module

perPage(Integer) - Method in class zendesk.support.HelpCenterSearch.Builder

Specifies the number of results to display per page

provider() - Method in enum zendesk.core.Zendesk

Gets a ProviderStore for accessing all available SDK Providers.

provider() - Method in enum zendesk.support.Support

Gets a ProviderStore for accessing all available SDK Providers.

ProviderStore - Interface in zendesk.core

Interface used to expose Providers through Zendesk.

ProviderStore - Interface in zendesk.support

Interface used to expose Providers through Support.

pushRegistrationProvider() - Method in interface zendesk.core.ProviderStore

Returns an implementation of PushRegistrationProvider

PushRegistrationProvider - Interface in zendesk.core

A provider which will offer a higher level of abstraction compared to the PushRegistrationService
You can create an instance of PushRegistrationProvider like this:

put(String, Object) - Method in interface zendesk.core.BaseStorage

Store the the given key value pair.

put(String, Object) - Method in interface zendesk.core.MemoryCache

put(String, String) - Method in interface zendesk.core.BaseStorage

Store the the given key value pair.

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().

register() - Method in interface zendesk.core.NetworkInfoProvider

Begin listening for network change events.

registerDeviceWithIdentifier(String, <any>) - Method in interface zendesk.core.PushRegistrationProvider

Calls a push registration service to register a given identifier to receive push notifications.

registerDeviceWithUAChannelId(String, <any>) - Method in interface zendesk.core.PushRegistrationProvider

Calls a push registration service to register a given Urban Airship channel id to receive push notifications.

remove(String) - Method in interface zendesk.core.BaseStorage

Remove the stored value for the provided key.

remove(String) - Method in interface zendesk.core.MemoryCache

remove(ActionHandler) - Method in interface zendesk.core.ActionHandlerRegistry

Removes an ActionHandler from the registry.

removeNetworkAwareListener(Integer) - Method in interface zendesk.core.NetworkInfoProvider

Remove a NetworkAware listener object so that it will no longer receive updates to network state.

removeRetryAction(Integer) - Method in interface zendesk.core.NetworkInfoProvider

Remove a RetryAction so that it will not be invoked next time the provider is notified with network availability.

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

requestCreated(String) - Method in interface zendesk.support.SupportBlipsProvider

Tracks creation of a Support request as a UserAction blip.

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

RequestListUiConfig - Class in zendesk.support.requestlist

Data class, that represents the initial configuration of RequestListActivity.

RequestListUiConfig.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

RequestUiConfig - Class in zendesk.support.request

Data class, that represents the initial configuration of RequestActivity.

RequestUiConfig.Builder - Class in zendesk.support.request

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

RestServiceProvider - Interface in zendesk.core

A Provider which is used to create RestApis for sub-SDKs.

RetryAction - Interface in zendesk.core

RetryAction specifies behavior of things that can be retried

S

SDK_GUID_HEADER - Static variable in interface zendesk.support.Constants

Mobile-Sdk-Identity header name, used to convey identity information.

SdkSettingsProvider - Interface in zendesk.core

A provider which will offer a higher level of abstraction compared to the SdkSettingsService
This provider is used internally by the SDK and does not need to be called explicitly.

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

sendBlip(BlipsGroup, PageView) - Method in interface zendesk.core.BlipsProvider

Track a page view.

sendBlip(BlipsGroup, UserAction) - Method in interface zendesk.core.BlipsProvider

Track a user action

SessionStorage - Interface in zendesk.core

Class holding storage that is tied to a user.

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.

setCustomFields(List<CustomField>) - Method in enum zendesk.support.Support

Set a List of type CustomField to be used on request submission until unset See Mobile SDK documentation for more information on setting this.

setDescription(String) - Method in class zendesk.support.CreateRequest

Sets the description of this request

setDeviceLocale(Locale) - Method in enum zendesk.support.Support

Sets the preferred device locale.

setExpanded(boolean) - Method in class zendesk.support.CategoryItem

Sets the expanded state.

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

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.

setTicketFormId(Long) - Method in enum zendesk.support.Support

Set a ticket form id which will be included in all request submission until unset See Mobile SDK documentation for more information on setting this.

Settings - Interface in zendesk.core

Marker interface for SDK-specific Settings objects.

SettingsPack<E extends Settings> - Class in zendesk.core

Object for holding core settings and SDK specific settings.

setUserFields(Map<String, String>, <any>) - Method in interface zendesk.core.UserProvider

Sets the user fields for the current user.

setValue(String) - Method in class zendesk.support.EndUserComment

Sets the value of this comment, e.g.

show(Context) - Method in class zendesk.support.guide.ArticleUiConfig.Builder

Shows the activity.

show(Context) - Method in class zendesk.support.guide.HelpCenterUiConfig.Builder

Starts the HelpCenterActivity.

show(Context) - Method in class zendesk.support.request.RequestUiConfig.Builder

Display RequestActivity to the user.

show(Context) - Method in class zendesk.support.requestlist.RequestListUiConfig.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

showError(int) - Method in class zendesk.support.guide.HelpCenterActivity

showErrorWithRetry(HelpCenterMvp.ErrorType, RetryAction) - Method in class zendesk.support.guide.HelpCenterActivity

showHelp(HelpCenterUiConfig) - Method in class zendesk.support.guide.HelpCenterActivity

showLoadingState() - 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.

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

SupportModule - Class in zendesk.support

Module holding references to internal dependencies.

SupportModule(RequestProvider, UploadProvider, HelpCenterProvider, SupportSettingsProvider, SupportBlipsProvider, OkHttpClient, ZendeskTracker, RequestStorage, 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

SupportSettings - Class in zendesk.support

This model contains the server-driven configurations that can affect how the SDK behaves.

SupportSettingsProvider - Interface in zendesk.support

A provider which will offer a higher level of abstraction compared to the com.zendesk.sdk.network.SdkSettingsService
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 fields.

TicketField(long, TicketFieldType, String, String, String, List<TicketFieldOption>) - Constructor for class zendesk.support.TicketField

Constructor for creating an instance of a ticket field.

TicketFieldOption - Class in zendesk.support

Model class for ticket field option.

TicketFieldOption(long, String, String, boolean) - Constructor for class zendesk.support.TicketFieldOption

Constructor for creating an instance of a ticket field 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

UiConfig - Interface in zendesk.support

Configuration for a screen of the SDK.

UiUtils.ScreenSize - Enum in zendesk.support

UNKNOWN_VOTE_COUNT - Static variable in class zendesk.support.Article

unregister() - Method in interface zendesk.core.NetworkInfoProvider

Stop listening for network change events.

unregisterDevice(<any>) - Method in interface zendesk.core.PushRegistrationProvider

Calls a push registration service to unregister a device to receive push notifications.

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 HelpCenterAttachment.

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.core

This is a model class for a User

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.core.User

Initialises a user with default values.

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.

UserAction - Class in zendesk.core

UserAction(String, String, String, String) - Constructor for class zendesk.core.UserAction

UserAction(String, String, String, String, String, Map<String, Object>) - Constructor for class zendesk.core.UserAction

UserField - Class in zendesk.core

This is a model class for a user field that will be created by the UserProvider as part of UserFieldResponse.

UserField() - Constructor for class zendesk.core.UserField

UserFieldOption - Class in zendesk.core

This is a model class for a user field option that will be created by the UserProvider as part of UserField.

UserFieldOption() - Constructor for class zendesk.core.UserFieldOption

userProvider() - Method in interface zendesk.core.ProviderStore

Returns an implementation of UserProvider

UserProvider - Interface in zendesk.core

Setting tags and fields on a user are features.

V

valueOf(String) - Static method in enum zendesk.core.AuthenticationType

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

valueOf(String) - Static method in enum zendesk.core.BlipsGroup

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

valueOf(String) - Static method in enum zendesk.core.Zendesk

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

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.core.AuthenticationType

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

values() - Static method in enum zendesk.core.BlipsGroup

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

values() - Static method in enum zendesk.core.Zendesk

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

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.HelpCenterUiConfig.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.HelpCenterUiConfig.Builder

Specifies a startup configuration which will show articles for a given set of category IDs

withArticlesForSectionIds(Long...) - Method in class zendesk.support.guide.HelpCenterUiConfig.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.HelpCenterUiConfig.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

withArticleVoting(boolean) - Method in class zendesk.support.guide.ArticleUiConfig.Builder

Specifies whether voting on articles should be enabled or disabled.

withCategoriesCollapsed(boolean) - Method in class zendesk.support.guide.HelpCenterUiConfig.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.ArticleUiConfig.Builder

Define which screens the "ContactUs" Floating Action Button should be shown on.

withContactUsButtonVisible(boolean) - Method in class zendesk.support.guide.HelpCenterUiConfig.Builder

Define which screens the "ContactUs" Floating Action Button should be shown on.

withCustomFields(List<CustomField>) - Method in class zendesk.support.request.RequestUiConfig.Builder

Attach a custom field form to the request.

withEmailIdentifier(String) - Method in class zendesk.core.AnonymousIdentity.Builder

Specify the Email to be used as part of the identity when using Anonymous Access

withFiles(File...) - Method in class zendesk.support.request.RequestUiConfig.Builder

Specify File objects to be selected as an attachment to any requests created using this RequestUiConfig.

withFiles(List<File>) - Method in class zendesk.support.request.RequestUiConfig.Builder

Specify a list of File objects to be selected as attachments to any requests created using this RequestUiConfig.

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.HelpCenterUiConfig.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.HelpCenterUiConfig.Builder

Specifies a startup configuration which will restrict the shown articles to ones that match the provided label names.

withLocalRequestId(String) - Method in class zendesk.support.request.RequestUiConfig.Builder

withNameIdentifier(String) - Method in class zendesk.core.AnonymousIdentity.Builder

Specify the Name to be used as part of the identity when using Anonymous Access.

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.RequestUiConfig.Builder

Show an existing request.

withRequestId(String) - Method in class zendesk.support.request.RequestUiConfig.Builder

Show an existing request.

withRequestSubject(String) - Method in class zendesk.support.request.RequestUiConfig.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.HelpCenterUiConfig.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.RequestUiConfig.Builder

Attach tags to the created request.

withTags(List<String>) - Method in class zendesk.support.request.RequestUiConfig.Builder

Attach tags to the created request.

withTicketForm(long, List<CustomField>) - Method in class zendesk.support.request.RequestUiConfig.Builder

Attach a ticket form to the request.

withUiConfigs(List<UiConfig>) - Method in class zendesk.support.guide.ArticleUiConfig.Builder

Configurations for screen that can be started from ViewArticleActivity.

withUiConfigs(List<UiConfig>) - Method in class zendesk.support.guide.HelpCenterUiConfig.Builder

Configurations for screen that can be started from HelpCenterActivity.

withUiConfigs(List<UiConfig>) - Method in class zendesk.support.request.RequestUiConfig.Builder

Configurations for screen that can be started from RequestActivity.

withUiConfigs(List<UiConfig>) - Method in class zendesk.support.requestlist.RequestListUiConfig.Builder

Configurations for screen that can be started from RequestListActivity.

withUiConfigs(UiConfig...) - Method in class zendesk.support.guide.ArticleUiConfig.Builder

Configurations for screen that can be started from ViewArticleActivity.

withUiConfigs(UiConfig...) - Method in class zendesk.support.guide.HelpCenterUiConfig.Builder

Configurations for screen that can be started from HelpCenterActivity.

withUiConfigs(UiConfig...) - Method in class zendesk.support.request.RequestUiConfig.Builder

Configurations for screen that can be started from RequestActivity.

withUiConfigs(UiConfig...) - Method in class zendesk.support.requestlist.RequestListUiConfig.Builder

Configurations for screen that can be started from RequestListActivity.

Z

Zendesk - Enum in zendesk.core

Configuration class for Zendesk Core SDK initialization.

zendesk.core - package zendesk.core

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

ZendeskDeepLinkParser.Module - Interface in zendesk.support

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