ApsAlert.Builder
extends Object| java.lang.Object | |
| ↳ | com.google.firebase.messaging.ApsAlert.Builder |
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ApsAlert.Builder |
addAllLocalizationArgs(List<String> args)
Adds a list of resource keys that will be used in place of the format specifiers in
bodyLocKey. | ||||||||||
| ApsAlert.Builder |
addAllSubtitleLocArgs(List<String> args)
Adds a list of resource keys that will be used in place of the format specifiers in
subtitleLocKey. | ||||||||||
| ApsAlert.Builder |
addAllTitleLocArgs(List<String> args)
Adds a list of resource keys that will be used in place of the format specifiers in
titleLocKey. | ||||||||||
| ApsAlert.Builder |
addLocalizationArg(String arg)
Adds a resource key string that will be used in place of the format specifiers in
bodyLocKey. | ||||||||||
| ApsAlert.Builder |
addSubtitleLocalizationArg(String arg)
Adds a resource key string that will be used in place of the format specifiers in
subtitleLocKey. | ||||||||||
| ApsAlert.Builder |
addTitleLocalizationArg(String arg)
Adds a resource key string that will be used in place of the format specifiers in
titleLocKey. | ||||||||||
| ApsAlert |
build()
Creates a new
ApsAlert instance from the parameters set on this builder. | ||||||||||
| ApsAlert.Builder |
setActionLocalizationKey(String actionLocKey)
Sets the key of the text in the app's string resources to use to localize the action button
text.
| ||||||||||
| ApsAlert.Builder |
setBody(String body)
Sets the body of the alert.
| ||||||||||
| ApsAlert.Builder |
setLaunchImage(String launchImage)
Sets the launch image for the notification action.
| ||||||||||
| ApsAlert.Builder |
setLocalizationKey(String locKey)
Sets the key of the body string in the app's string resources to use to localize the body
text.
| ||||||||||
| ApsAlert.Builder |
setSubtitle(String subtitle)
Sets the subtitle of the alert.
| ||||||||||
| ApsAlert.Builder |
setSubtitleLocalizationKey(String subtitleLocKey)
Sets the key of the subtitle string in the app's string resources to use to localize
the subtitle text.
| ||||||||||
| ApsAlert.Builder |
setTitle(String title)
Sets the title of the alert.
| ||||||||||
| ApsAlert.Builder |
setTitleLocalizationKey(String titleLocKey)
Sets the key of the title string in the app's string resources to use to localize the title
text.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public ApsAlert.Builder addAllLocalizationArgs (List<String> args)
Adds a list of resource keys that will be used in place of the format specifiers in
bodyLocKey.
Parameters
| args | List of resource key strings. |
|---|
Returns
- This builder.
public ApsAlert.Builder addAllSubtitleLocArgs (List<String> args)
Adds a list of resource keys that will be used in place of the format specifiers in
subtitleLocKey.
Parameters
| args | List of resource key strings. |
|---|
Returns
- This builder.
public ApsAlert.Builder addAllTitleLocArgs (List<String> args)
Adds a list of resource keys that will be used in place of the format specifiers in
titleLocKey.
Parameters
| args | List of resource key strings. |
|---|
Returns
- This builder.
public ApsAlert.Builder addLocalizationArg (String arg)
Adds a resource key string that will be used in place of the format specifiers in
bodyLocKey.
Parameters
| arg | Resource key string. |
|---|
Returns
- This builder.
public ApsAlert.Builder addSubtitleLocalizationArg (String arg)
Adds a resource key string that will be used in place of the format specifiers in
subtitleLocKey.
Parameters
| arg | Resource key string. |
|---|
Returns
- This builder.
public ApsAlert.Builder addTitleLocalizationArg (String arg)
Adds a resource key string that will be used in place of the format specifiers in
titleLocKey.
Parameters
| arg | Resource key string. |
|---|
Returns
- This builder.
public ApsAlert build ()
public ApsAlert.Builder setActionLocalizationKey (String actionLocKey)
Sets the key of the text in the app's string resources to use to localize the action button text.
Parameters
| actionLocKey | Resource key string. |
|---|
Returns
- This builder.
public ApsAlert.Builder setBody (String body)
Sets the body of the alert. When provided, overrides the body sent
via Notification.
Parameters
| body | Body of the notification. |
|---|
Returns
- This builder.
public ApsAlert.Builder setLaunchImage (String launchImage)
Sets the launch image for the notification action.
Parameters
| launchImage | An image file name. |
|---|
Returns
- This builder.
public ApsAlert.Builder setLocalizationKey (String locKey)
Sets the key of the body string in the app's string resources to use to localize the body text.
Parameters
| locKey | Resource key string. |
|---|
Returns
- This builder.
public ApsAlert.Builder setSubtitle (String subtitle)
Sets the subtitle of the alert.
Parameters
| subtitle | Subtitle of the notification. |
|---|
Returns
- This builder.
public ApsAlert.Builder setSubtitleLocalizationKey (String subtitleLocKey)
Sets the key of the subtitle string in the app's string resources to use to localize the subtitle text.
Parameters
| subtitleLocKey | Resource key string. |
|---|
Returns
- This builder.
public ApsAlert.Builder setTitle (String title)
Sets the title of the alert. When provided, overrides the title sent
via Notification.
Parameters
| title | Title of the notification. |
|---|
Returns
- This builder.
public ApsAlert.Builder setTitleLocalizationKey (String titleLocKey)
Sets the key of the title string in the app's string resources to use to localize the title text.
Parameters
| titleLocKey | Resource key string. |
|---|
Returns
- This builder.