Package com.zendesk.sdk.deeplinking

Enum ZendeskDeepLinking

java.lang.Object

java.lang.Enum<ZendeskDeepLinking>

com.zendesk.sdk.deeplinking.ZendeskDeepLinking

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ZendeskDeepLinking>

public enum ZendeskDeepLinking
extends java.lang.Enum<ZendeskDeepLinking>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
Intent	getArticleIntent(Context context, Article article, java.util.ArrayList<Intent> backStackActivities, Intent fallbackActivity) Get an pre-configured Intent to open an article.
Intent	getArticleIntent(Context context, Article article, java.util.ArrayList<Intent> backStackItemArrayList, Intent fallbackActivity, java.lang.String zendeskUrl, java.lang.String applicationId, java.lang.String oauthClientId) Get an pre-configured Intent to open an article.
Intent	getArticleIntent(Context context, SimpleArticle simpleArticle, java.util.ArrayList<Intent> backStackActivities, Intent fallbackActivity) Get an pre-configured Intent to open an article.
Intent	getArticleIntent(Context context, SimpleArticle simpleArticle, java.util.ArrayList<Intent> backStackItemArrayList, Intent fallbackActivity, java.lang.String zendeskUrl, java.lang.String applicationId, java.lang.String oauthClientId) Get an pre-configured Intent to open an article.
Intent	getRequestIntent(Context context, java.lang.String requestId, java.lang.String subject, java.util.ArrayList<Intent> backStackActivities, Intent fallbackActivity) Get an pre-configured Intent to open a request.
Intent	getRequestIntent(Context context, java.lang.String requestId, java.lang.String subject, java.util.ArrayList<Intent> backStackActivities, Intent fallbackActivity, java.lang.String zendeskUrl, java.lang.String applicationId, java.lang.String oauthClientId) Get an pre-configured Intent to open a request.
boolean	refreshComments(java.lang.String requestId) Will reload comments in a ViewRequestFragment if it is visible to the user and displaying the given requestId.
void	registerAction(ActionHandler actionHandler, Action... actions) Register an ActionHandler
void	unregisterAction(ActionHandler actionHandler) Unregister an ActionHandler
static ZendeskDeepLinking	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ZendeskDeepLinking[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final ZendeskDeepLinking INSTANCE

Method Detail

values

public static ZendeskDeepLinking[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ZendeskDeepLinking c : ZendeskDeepLinking.values())
    System.out.println(c);

Returns:

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

valueOf

public static ZendeskDeepLinking valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

registerAction

public void registerAction(ActionHandler actionHandler,
                           Action... actions)

Register an ActionHandler

Use this method to register an Activity or Fragment to handle the specified Action

Parameters:

actionHandler - The ActionHandler

actions - An array of Actions that can be handled by the given ActionHandler

unregisterAction

public void unregisterAction(ActionHandler actionHandler)

Unregister an ActionHandler

Parameters:

actionHandler - The ActionHandler

refreshComments

public boolean refreshComments(java.lang.String requestId)

Will reload comments in a ViewRequestFragment if it is visible to the user and displaying the given requestId.

Parameters:

requestId - A request id

Returns:

True if a reload was triggered, false if not.

getRequestIntent

public Intent getRequestIntent(Context context,
                               java.lang.String requestId,
                               java.lang.String subject,
                               java.util.ArrayList<Intent> backStackActivities,
                               Intent fallbackActivity)

Get an pre-configured Intent to open a request.

Make sure, whenever you call this method, that your ZendeskConfig is initialized. If not this method will return null.
If you aren't sure, please use ZendeskDeepLinking.getRequestIntent(Context, String, String, ArrayList, Intent, String, String, String)
Execute the returned intent by calling Activity#sendBroadcast(Intent) or by creating an PendingIntent by calling PendingIntent#getService(Context, int, Intent, int)

Adding backstack activities won't work on devices with API level 10 and below.

Parameters:

context - An application context

requestId - A valid requestId

subject - A subject

backStackActivities - A list of back stack activities

fallbackActivity - An activity that will be shown, if something fails (e.g. user configuration changed)

Returns:

An intent

See Also:

http://developer.android.com/reference/android/support/v4/app/TaskStackBuilder.html

getRequestIntent

public Intent getRequestIntent(Context context,
                               java.lang.String requestId,
                               java.lang.String subject,
                               java.util.ArrayList<Intent> backStackActivities,
                               Intent fallbackActivity,
                               java.lang.String zendeskUrl,
                               java.lang.String applicationId,
                               java.lang.String oauthClientId)

Get an pre-configured Intent to open a request.

Call the method if you aren't sure if ZendeskConfig is initialized.
Execute the returned intent by calling Activity#sendBroadcast(Intent) or by creating an PendingIntent by calling PendingIntent#getService(Context, int, Intent, int)

Adding backstack activities won't work on devices with API level 10 and below.

Parameters:

context - An application context

requestId - A valid requestId

subject - A subject

backStackActivities - A list of back stack activities

fallbackActivity - An activity that will be shown, if something fails (e.g. user configuration changed)

zendeskUrl - The full URL of your Zendesk instance, https://{subdomain}.zendesk.com

applicationId - The application id of your SDK app, as found in the web interface

oauthClientId - The oauth client id that was supplied when you set up oauth in the web interface

Returns:

An intent

See Also:

http://developer.android.com/reference/android/support/v4/app/TaskStackBuilder.html

getArticleIntent

public Intent getArticleIntent(Context context,
                               Article article,
                               java.util.ArrayList<Intent> backStackActivities,
                               Intent fallbackActivity)

Get an pre-configured Intent to open an article.

Make sure, whenever you call this method, that your ZendeskConfig is initialized. If not this method will return null.
If you aren't sure, please use ZendeskDeepLinking.getArticleIntent(Context, Article, ArrayList, Intent, String, String, String)
Execute the returned intent by calling Activity#sendBroadcast(Intent) or by creating an PendingIntent by calling PendingIntent#getService(Context, int, Intent, int)

Adding backstack activities won't work on devices with API level 10 and below.

Parameters:

context - An application context

article - An article

backStackActivities - A list of back stack activities

fallbackActivity - An activity that will be shown, if something fails (e.g. user configuration changed)

Returns:

An intent

See Also:

http://developer.android.com/reference/android/support/v4/app/TaskStackBuilder.html

getArticleIntent

public Intent getArticleIntent(Context context,
                               Article article,
                               java.util.ArrayList<Intent> backStackItemArrayList,
                               Intent fallbackActivity,
                               java.lang.String zendeskUrl,
                               java.lang.String applicationId,
                               java.lang.String oauthClientId)

Get an pre-configured Intent to open an article.

Call the method if you aren't sure if ZendeskConfig is initialized.
Execute the returned intent by calling Activity#sendBroadcast(Intent) or by creating an PendingIntent by calling PendingIntent#getService(Context, int, Intent, int)

Adding backstack activities won't work on devices with API level 10 and below.

Parameters:

context - An application context

article - An article

backStackItemArrayList - A list of back stack activities

fallbackActivity - An activity that will be shown, if something fails (e.g. user configuration changed)

zendeskUrl - The full URL of your Zendesk instance, https://{subdomain}.zendesk.com

applicationId - The application id of your SDK app, as found in the web interface

oauthClientId - The oauth client id that was supplied when you set up oauth in the web interface

Returns:

An intent

See Also:

http://developer.android.com/reference/android/support/v4/app/TaskStackBuilder.html

getArticleIntent

public Intent getArticleIntent(Context context,
                               SimpleArticle simpleArticle,
                               java.util.ArrayList<Intent> backStackActivities,
                               Intent fallbackActivity)

Get an pre-configured Intent to open an article.

Make sure, whenever you call this method, that your ZendeskConfig is initialized. If not this method will return null.
If you aren't sure, please use ZendeskDeepLinking.getArticleIntent(Context, Article, ArrayList, Intent, String, String, String)
Execute the returned intent by calling Activity#sendBroadcast(Intent) or by creating an PendingIntent by calling PendingIntent#getService(Context, int, Intent, int)

Adding backstack activities won't work on devices with API level 10 and below.

Parameters:

context - An application context

simpleArticle - A simple article (e.g. received from HelpCenterProvider#getSuggestedArticles(SuggestedArticleSearch, ZendeskCallback)

backStackActivities - A list of back stack activities

fallbackActivity - An activity that will be shown, if something fails (e.g. user configuration changed)

Returns:

An intent

See Also:

http://developer.android.com/reference/android/support/v4/app/TaskStackBuilder.html

getArticleIntent

public Intent getArticleIntent(Context context,
                               SimpleArticle simpleArticle,
                               java.util.ArrayList<Intent> backStackItemArrayList,
                               Intent fallbackActivity,
                               java.lang.String zendeskUrl,
                               java.lang.String applicationId,
                               java.lang.String oauthClientId)

Get an pre-configured Intent to open an article.

Call the method if you aren't sure if ZendeskConfig is initialized.
Execute the returned intent by calling Activity#sendBroadcast(Intent) or by creating an PendingIntent by calling PendingIntent#getService(Context, int, Intent, int)

Adding backstack activities won't work on devices with API level 10 and below.

Parameters:

context - An application context

simpleArticle - A simple article (e.g. received from HelpCenterProvider#getSuggestedArticles(SuggestedArticleSearch, ZendeskCallback)

backStackItemArrayList - A list of back stack activities

fallbackActivity - An activity that will be shown, if something fails (e.g. user configuration changed)

zendeskUrl - The full URL of your Zendesk instance, https://{subdomain}.zendesk.com

applicationId - The application id of your SDK app, as found in the web interface

oauthClientId - The oauth client id that was supplied when you set up oauth in the web interface

Returns:

An intent

See Also:

http://developer.android.com/reference/android/support/v4/app/TaskStackBuilder.html