public final class ApplicationShortcutItem extends Object implements PostJSONSerializable, PostJSONDeserializable
Modifier and Type | Class and Description |
---|---|
static class |
ApplicationShortcutItem.Icon
An application shortcut, or quick action, icon is an image you can optionally associate with a Home screen quick
action to improve its appearance and usability.
|
Constructor and Description |
---|
ApplicationShortcutItem()
Constucts an empty application shortcut item.
|
ApplicationShortcutItem(String type,
String localizedTitle)
Constuct an application shortcut item.
|
Modifier and Type | Method and Description |
---|---|
ApplicationShortcutItem.Icon |
getIcon()
Returns the optional icon for the Home screen dynamic quick action.
|
String |
getLocalizedSubtitle()
Returns the optional, user-visible subtitle for the Home screen dynamic quick action.
|
String |
getLocalizedTitle() |
String |
getType() |
java.util.HashMap<String,Object> |
getUserInfo()
Optional, app-specific information that you can provide for use when your app performs the Home screen quick action.
|
JSONObject |
modifyJSON(JSONObject jsonObj)
Method to add custom code to alter the Object after the serialization
process in JSONBeanSerializationHelper.toJSON()
|
Object |
modifyObject(JSONObject jsonObj)
Method to add custom code to alter the Object after the deserialization
process in JSONBeanSerializationHelper.fromJSON()
|
void |
setIcon(ApplicationShortcutItem.Icon icon)
Sets the the optional icon for the Home screen dynamic quick action.
|
void |
setLocalizedSubtitle(String localizedSubtitle)
Set the optional, user-visible subtitle for the Home screen dynamic quick action.
|
void |
setLocalizedTitle(String localizedTitle)
Sets the required, user-visible title of the Home screen quick action.
|
void |
setType(String type)
Sets the required, app-defined type of the Home screen quick action.
|
void |
setUserInfo(java.util.HashMap<String,Object> userInfo)
Optional, app-specific information that you can provide for use when your app performs the Home screen quick action.
|
String |
toString() |
public ApplicationShortcutItem()
public ApplicationShortcutItem(String type, String localizedTitle)
type
- the required, app-defined type of the Home screen quick action.localizedTitle
- the shortcut item titlepublic void setType(String type)
type
- the ytpe valuepublic final String getType()
public final String getLocalizedTitle()
public final void setLocalizedSubtitle(String localizedSubtitle)
localizedSubtitle
- the new subtitlepublic final String getLocalizedSubtitle()
public final void setUserInfo(java.util.HashMap<String,Object> userInfo)
userInfo
- The user information to setpublic final java.util.HashMap<String,Object> getUserInfo()
public JSONObject modifyJSON(JSONObject jsonObj)
PostJSONSerializable
modifyJSON
in interface PostJSONSerializable
jsonObj
- JSON Object to be alteredpublic Object modifyObject(JSONObject jsonObj) throws Exception
PostJSONDeserializable
modifyObject
in interface PostJSONDeserializable
jsonObj
- JSON Object to be alteredException
public void setLocalizedTitle(String localizedTitle)
localizedTitle
- the new titlepublic void setIcon(ApplicationShortcutItem.Icon icon)
icon
- The new icon valuepublic ApplicationShortcutItem.Icon getIcon()
public String toString()
toString
in class Object