net.gotev.uploadservice

Class UploadNotificationConfig

java.lang.Object

net.gotev.uploadservice.UploadNotificationConfig

All Implemented Interfaces:

Parcelable

public final class UploadNotificationConfig
extends Object
implements Parcelable

Contains the configuration of the upload notification.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<UploadNotificationConfig>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description

UploadNotificationConfig() Creates a new upload notification configuration with default settings: android.R.drawable.ic_menu_upload will be used as the icon If the user taps on the notification, nothing will happen Once the operation is completed (either successfully or with an error): the default notification sound will be emitted (or the default notification vibration if the device is in silent mode) the notification will remain in the Notification Center until the user swipes it out

Method Summary

Modifier and Type	Method and Description
UploadNotificationConfig	addActionForAllStatuses(UploadNotificationAction action) Adds the same notification action for all the notification statuses.
int	describeContents()
UploadNotificationStatusConfig	getCancelled()
UploadNotificationStatusConfig	getCompleted()
UploadNotificationStatusConfig	getError()
String	getNotificationChannelId()
UploadNotificationStatusConfig	getProgress()
boolean	isRingToneEnabled()
UploadNotificationConfig	setClearOnActionForAllStatuses(boolean clearOnAction) Sets whether or not to clear the notification when the user taps on it for all the notification statuses.
UploadNotificationConfig	setClickIntentForAllStatuses(PendingIntent clickIntent) Sets the same intent to be executed when the user taps on the notification for all the notification statuses.
UploadNotificationConfig	setIconColorForAllStatuses(int iconColorResourceID) Sets the same notification icon for all the notification statuses.
UploadNotificationConfig	setIconForAllStatuses(int resourceID) Sets the same notification icon for all the notification statuses.
UploadNotificationConfig	setLargeIconForAllStatuses(Bitmap largeIcon) Sets the same large notification icon for all the notification statuses.
UploadNotificationConfig	setNotificationChannelId(String channelId) Sets notification channel ID
UploadNotificationConfig	setRingToneEnabled(Boolean enabled) Sets whether or not to enable the notification sound when the upload gets completed with success or error.
UploadNotificationConfig	setTitleForAllStatuses(String title) Sets the notification title for all the notification statuses.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<UploadNotificationConfig> CREATOR

Constructor Detail

UploadNotificationConfig

public UploadNotificationConfig()

Creates a new upload notification configuration with default settings:

• android.R.drawable.ic_menu_upload will be used as the icon
• If the user taps on the notification, nothing will happen
• Once the operation is completed (either successfully or with an error):
  • the default notification sound will be emitted (or the default notification vibration if the device is in silent mode)
  • the notification will remain in the Notification Center until the user swipes it out

Method Detail

setTitleForAllStatuses

public final UploadNotificationConfig setTitleForAllStatuses(String title)

Sets the notification title for all the notification statuses.

Parameters:

title - Title to show in the notification icon

Returns:

UploadNotificationConfig

setIconForAllStatuses

public final UploadNotificationConfig setIconForAllStatuses(int resourceID)

Sets the same notification icon for all the notification statuses.

Parameters:

resourceID - Resource ID of the icon to use

Returns:

UploadNotificationConfig

setIconColorForAllStatuses

public final UploadNotificationConfig setIconColorForAllStatuses(int iconColorResourceID)

Sets the same notification icon for all the notification statuses.

Parameters:

iconColorResourceID - Resource ID of the color to use

Returns:

UploadNotificationConfig

setLargeIconForAllStatuses

public final UploadNotificationConfig setLargeIconForAllStatuses(Bitmap largeIcon)

Sets the same large notification icon for all the notification statuses.

Parameters:

largeIcon - Bitmap of the icon to use

Returns:

UploadNotificationConfig

setClickIntentForAllStatuses

public final UploadNotificationConfig setClickIntentForAllStatuses(PendingIntent clickIntent)

Sets the same intent to be executed when the user taps on the notification for all the notification statuses.

Parameters:

clickIntent - PendingIntent containing the user's action

Returns:

UploadNotificationConfig

addActionForAllStatuses

public final UploadNotificationConfig addActionForAllStatuses(UploadNotificationAction action)

Adds the same notification action for all the notification statuses. So for example, if you want to have the same action while the notification is in progress, cancelled, completed or with an error, this method will save you lines of code.

Parameters:

action - UploadNotificationAction action to add

Returns:

UploadNotificationConfig

setClearOnActionForAllStatuses

public final UploadNotificationConfig setClearOnActionForAllStatuses(boolean clearOnAction)

Sets whether or not to clear the notification when the user taps on it for all the notification statuses. This would not affect progress notification, as it's ongoing and managed by the upload service.

Parameters:

clearOnAction - true to clear the notification, otherwise false

Returns:

UploadNotificationConfig

setRingToneEnabled

public final UploadNotificationConfig setRingToneEnabled(Boolean enabled)

Sets whether or not to enable the notification sound when the upload gets completed with success or error.

Parameters:

enabled - true to enable the default ringtone

Returns:

UploadNotificationConfig

setNotificationChannelId

public final UploadNotificationConfig setNotificationChannelId(String channelId)

Sets notification channel ID

Parameters:

channelId - notification channel ID

Returns:

UploadNotificationConfig

isRingToneEnabled

public boolean isRingToneEnabled()

getProgress

public UploadNotificationStatusConfig getProgress()

getCompleted

public UploadNotificationStatusConfig getCompleted()

getError

public UploadNotificationStatusConfig getError()

getCancelled

public UploadNotificationStatusConfig getCancelled()

getNotificationChannelId

public String getNotificationChannelId()

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable