io.branch.referral.util

Class ShareSheetStyle

java.lang.Object

io.branch.referral.util.ShareSheetStyle

public class ShareSheetStyle
extends java.lang.Object

Class for defining the share sheet properties. Defines the properties of share sheet. Use this class customise the share sheet style.

See Also:

BranchUniversalObject.showShareSheet(Activity, LinkProperties, ShareSheetStyle, Branch.BranchLinkShareListener)

Constructor Summary

Constructors

Constructor and Description
ShareSheetStyle(android.content.Context context, java.lang.String messageTitle, java.lang.String messageBody)

Method Summary

Modifier and Type	Method and Description
ShareSheetStyle	addPreferredSharingOption(SharingHelper.SHARE_WITH preferredOption) Adds application to the preferred list of applications which are shown on share dialog.
ShareSheetStyle	excludeFromShareSheet(java.util.List<java.lang.String> packageNames) Exclude items from the ShareSheet by package name List.
ShareSheetStyle	excludeFromShareSheet(java.lang.String packageName) Exclude items from the ShareSheet by package name String.
ShareSheetStyle	excludeFromShareSheet(java.lang.String[] packageName) Exclude items from the ShareSheet by package name array.
android.graphics.drawable.Drawable	getCopyUrlIcon()
java.lang.String	getCopyURlText()
java.lang.String	getDefaultURL()
int	getDialogThemeResourceID()
int	getDividerHeight()
java.util.List<java.lang.String>	getExcludedFromShareSheet()
int	getIconSize()
java.util.List<java.lang.String>	getIncludedInShareSheet()
boolean	getIsFullWidthStyle()
java.lang.String	getMessageBody()
java.lang.String	getMessageTitle()
android.graphics.drawable.Drawable	getMoreOptionIcon()
java.lang.String	getMoreOptionText()
java.util.ArrayList<SharingHelper.SHARE_WITH>	getPreferredOptions()
java.lang.String	getSharingTitle()
android.view.View	getSharingTitleView()
int	getStyleResourceID()
java.lang.String	getUrlCopiedMessage()
ShareSheetStyle	includeInShareSheet(java.util.List<java.lang.String> packageNames) Include items from the ShareSheet by package name List.
ShareSheetStyle	includeInShareSheet(java.lang.String packageName) Include items from the ShareSheet by package name String.
ShareSheetStyle	includeInShareSheet(java.lang.String[] packageName) Include items from the ShareSheet by package name Array.
ShareSheetStyle	setAsFullWidthStyle(boolean setFullWidthStyle) Sets the share dialog to full width mode.
ShareSheetStyle	setCopyUrlStyle(android.graphics.drawable.Drawable icon, java.lang.String label, java.lang.String message) Set the icon, label and success message for copy url option.
ShareSheetStyle	setCopyUrlStyle(int drawableIconID, int stringLabelID, int stringMessageID) Set the icon, label and success message for copy url option.
ShareSheetStyle	setDefaultURL(java.lang.String url) Set a default url to share in case there is any error creating the deep link
ShareSheetStyle	setDialogThemeResourceID(int styleResourceID) Set the given style to the dialog showing the share sheet
ShareSheetStyle	setDividerHeight(int height) Set the height for the divider for the sharing channels in the list.
ShareSheetStyle	setIconSize(int iconSize) Set icon size (converted to DP) for the sharing dialog
ShareSheetStyle	setMoreOptionStyle(android.graphics.drawable.Drawable icon, java.lang.String label) Set the icon and label for the option to expand the application list to see more options.
ShareSheetStyle	setMoreOptionStyle(int drawableIconID, int stringLabelID) Set the icon and label for the option to expand the application list to see more options.
ShareSheetStyle	setSharingTitle(java.lang.String title) Set the title for the sharing dialog
ShareSheetStyle	setSharingTitle(android.view.View titleView) Set the title for the sharing dialog
ShareSheetStyle	setStyleResourceID(int styleResourceID) Set the given style to the List View showing the share sheet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShareSheetStyle

public ShareSheetStyle(android.content.Context context,
                       java.lang.String messageTitle,
                       java.lang.String messageBody)

Method Detail

setDefaultURL

public ShareSheetStyle setDefaultURL(java.lang.String url)

Set a default url to share in case there is any error creating the deep link

Parameters:

url - A String with value of default url to be shared with the selected application in case deep link creation fails.

Returns:

This object to allow method chaining

setMoreOptionStyle

public ShareSheetStyle setMoreOptionStyle(android.graphics.drawable.Drawable icon,
                                          java.lang.String label)

Set the icon and label for the option to expand the application list to see more options. Default label is set to "More"

Parameters:

icon - Drawable to set as the icon for more option. Default icon is system menu_more icon.

label - A String with value for the more option label. Default label is "More"

Returns:

This object to allow method chaining

setMoreOptionStyle

public ShareSheetStyle setMoreOptionStyle(int drawableIconID,
                                          int stringLabelID)

Set the icon and label for the option to expand the application list to see more options. Default label is set to "More"

Parameters:

drawableIconID - Resource ID for the drawable to set as the icon for more option. Default icon is system menu_more icon.

stringLabelID - Resource ID for String label for the more option. Default label is "More"

Returns:

This object to allow method chaining

setCopyUrlStyle

public ShareSheetStyle setCopyUrlStyle(android.graphics.drawable.Drawable icon,
                                       java.lang.String label,
                                       java.lang.String message)

Set the icon, label and success message for copy url option. Default label is "Copy link".

Parameters:

icon - Drawable to set as the icon for copy url option. Default icon is system menu_save icon

label - A String with value for the copy url option label. Default label is "Copy link"

message - A String with value for a toast message displayed on copying a url. Default message is "Copied link to clipboard!"

Returns:

This object to allow method chaining

setCopyUrlStyle

public ShareSheetStyle setCopyUrlStyle(int drawableIconID,
                                       int stringLabelID,
                                       int stringMessageID)

Set the icon, label and success message for copy url option. Default label is "Copy link".

Parameters:

drawableIconID - Resource ID for the drawable to set as the icon for copy url option. Default icon is system menu_save icon

stringLabelID - Resource ID for the string label the copy url option. Default label is "Copy link"

stringMessageID - Resource ID for the string message to show toast message displayed on copying a url

Returns:

A ShareSheetStyle instance.

addPreferredSharingOption

public ShareSheetStyle addPreferredSharingOption(SharingHelper.SHARE_WITH preferredOption)

Adds application to the preferred list of applications which are shown on share dialog. Only these options will be visible when the application selector dialog launches. Other options can be accessed by clicking "More"

Parameters:

preferredOption - A list of applications to be added as preferred options on the app chooser. Preferred applications are defined in SharingHelper.SHARE_WITH.

Returns:

This object to allow method chaining

setStyleResourceID

public ShareSheetStyle setStyleResourceID(int styleResourceID)

Set the given style to the List View showing the share sheet

Parameters:

styleResourceID - A Styleable resource to be applied to the share sheet list view

setDialogThemeResourceID

public ShareSheetStyle setDialogThemeResourceID(int styleResourceID)

Set the given style to the dialog showing the share sheet

Parameters:

styleResourceID - A Styleable resource to be applied to the share sheet dialog view

setAsFullWidthStyle

public ShareSheetStyle setAsFullWidthStyle(boolean setFullWidthStyle)

Sets the share dialog to full width mode. Full width mode will show a non modal sheet with entire screen width.

Parameters:

setFullWidthStyle - Boolean With value true if a full width style share sheet is desired.

Returns:

This Builder object to allow for chaining of calls to set methods.

setDividerHeight

public ShareSheetStyle setDividerHeight(int height)

Set the height for the divider for the sharing channels in the list. Set this to zero to remove the dividers

Parameters:

height - The new height of the divider in pixels.

Returns:

his Builder object to allow for chaining of calls to set methods.

setSharingTitle

public ShareSheetStyle setSharingTitle(java.lang.String title)

Set the title for the sharing dialog

Parameters:

title - String containing the value for the title text.

Returns:

this Builder object to allow for chaining of calls to set methods.

setSharingTitle

public ShareSheetStyle setSharingTitle(android.view.View titleView)

Set the title for the sharing dialog

Parameters:

titleView - View for setting the title.

Returns:

this Builder object to allow for chaining of calls to set methods.

excludeFromShareSheet

public ShareSheetStyle excludeFromShareSheet(java.lang.String packageName)

Exclude items from the ShareSheet by package name String.

Parameters:

packageName - String package name to be excluded.

Returns:

this Builder object to allow for chaining of calls to set methods.

excludeFromShareSheet

public ShareSheetStyle excludeFromShareSheet(java.lang.String[] packageName)

Exclude items from the ShareSheet by package name array.

Parameters:

packageName - String[] package name to be excluded.

Returns:

this Builder object to allow for chaining of calls to set methods.

excludeFromShareSheet

public ShareSheetStyle excludeFromShareSheet(java.util.List<java.lang.String> packageNames)

Exclude items from the ShareSheet by package name List.

Parameters:

packageNames - List package name to be excluded.

Returns:

this Builder object to allow for chaining of calls to set methods.

includeInShareSheet

public ShareSheetStyle includeInShareSheet(java.lang.String packageName)

Include items from the ShareSheet by package name String. If only "com.Slack" is included, then only preferred sharing options + Slack will be displayed, for example.

Parameters:

packageName - String package name to be included.

Returns:

this Builder object to allow for chaining of calls to set methods.

includeInShareSheet

public ShareSheetStyle includeInShareSheet(java.lang.String[] packageName)

Include items from the ShareSheet by package name Array. If only "com.Slack" is included, then only preferred sharing options + Slack will be displayed, for example.

Parameters:

packageName - String[] package name to be included.

Returns:

this Builder object to allow for chaining of calls to set methods.

includeInShareSheet

public ShareSheetStyle includeInShareSheet(java.util.List<java.lang.String> packageNames)

Include items from the ShareSheet by package name List. If only "com.Slack" is included, then only preferred sharing options + Slack will be displayed, for example.

Parameters:

packageNames - List package name to be included.

Returns:

this Builder object to allow for chaining of calls to set methods.

setIconSize

public ShareSheetStyle setIconSize(int iconSize)

Set icon size (converted to DP) for the sharing dialog

Parameters:

iconSize - int for setting the share sheet icon size.

Returns:

this Builder object to allow for chaining of calls to set methods.

getExcludedFromShareSheet

public java.util.List<java.lang.String> getExcludedFromShareSheet()

getIncludedInShareSheet

public java.util.List<java.lang.String> getIncludedInShareSheet()

getPreferredOptions

public java.util.ArrayList<SharingHelper.SHARE_WITH> getPreferredOptions()

getCopyUrlIcon

public android.graphics.drawable.Drawable getCopyUrlIcon()

getMoreOptionIcon

public android.graphics.drawable.Drawable getMoreOptionIcon()

getMessageBody

public java.lang.String getMessageBody()

getMessageTitle

public java.lang.String getMessageTitle()

getCopyURlText

public java.lang.String getCopyURlText()

getDefaultURL

public java.lang.String getDefaultURL()

getMoreOptionText

public java.lang.String getMoreOptionText()

getUrlCopiedMessage

public java.lang.String getUrlCopiedMessage()

getDividerHeight

public int getDividerHeight()

getSharingTitle

public java.lang.String getSharingTitle()

getSharingTitleView

public android.view.View getSharingTitleView()

getIsFullWidthStyle

public boolean getIsFullWidthStyle()

getDialogThemeResourceID

public int getDialogThemeResourceID()

getStyleResourceID

public int getStyleResourceID()

getIconSize

public int getIconSize()