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
int	describeContents()
UploadNotificationConfig	setAutoClearOnError(boolean clear) Sets whether or not to auto clear the notification when an error happens during upload.
UploadNotificationConfig	setAutoClearOnSuccess(boolean clear) Sets whether or not to auto clear the notification when the upload is completed successfully.
UploadNotificationConfig	setClearOnAction(boolean clear) Sets whether or not to clear the notification when the user taps on it.
UploadNotificationConfig	setClickIntent(Intent clickIntent) Sets the intent to be executed when the user taps on the notification.
UploadNotificationConfig	setCompletedIcon(int resourceID) Sets the icon to show in the notification when the operation is completed successfully.
UploadNotificationConfig	setCompletedMessage(String message) Sets the message to be shown when the upload is completed.
UploadNotificationConfig	setErrorIcon(int resourceID) Sets the icon to show in the notification when an error happens.
UploadNotificationConfig	setErrorMessage(String message) Sets the message to be shown if an error occurs.
UploadNotificationConfig	setIcon(int resourceID) Sets the notification icon.
UploadNotificationConfig	setInProgressMessage(String message) Sets the message to be shown while upload is in progress.
UploadNotificationConfig	setRingToneEnabled(Boolean enabled) Sets whether or not to enable the notification sound when the upload gets completed with success or error
UploadNotificationConfig	setTitle(String title) Sets the notification title.
void	writeToParcel(Parcel parcel, int arg1)

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

setIcon

public final UploadNotificationConfig setIcon(int resourceID)

Sets the notification icon.

Parameters:

resourceID - Resource ID of the icon to use

Returns:

UploadNotificationConfig

setCompletedIcon

public final UploadNotificationConfig setCompletedIcon(int resourceID)

Sets the icon to show in the notification when the operation is completed successfully. By default it's the same as the icon used while the operation is in progress.

Parameters:

resourceID - Resource ID of the icon to use

Returns:

UploadNotificationConfig

setErrorIcon

public final UploadNotificationConfig setErrorIcon(int resourceID)

Sets the icon to show in the notification when an error happens. By default it's the same as the icon used while the operation is in progress.

Parameters:

resourceID - Resource ID of the icon to use

Returns:

UploadNotificationConfig

setTitle

public final UploadNotificationConfig setTitle(String title)

Sets the notification title.

Parameters:

title - Title to show in the notification icon

Returns:

UploadNotificationConfig

setInProgressMessage

public final UploadNotificationConfig setInProgressMessage(String message)

Sets the message to be shown while upload is in progress. Null if no message should be displayed.

Parameters:

message - Message to show

Returns:

UploadNotificationConfig

setErrorMessage

public final UploadNotificationConfig setErrorMessage(String message)

Sets the message to be shown if an error occurs. Null if no message should be displayed.

Parameters:

message - Message to show

Returns:

UploadNotificationConfig

setCompletedMessage

public final UploadNotificationConfig setCompletedMessage(String message)

Sets the message to be shown when the upload is completed. Null if no message should be displayed.

Parameters:

message - Message to show

Returns:

UploadNotificationConfig

setAutoClearOnSuccess

public final UploadNotificationConfig setAutoClearOnSuccess(boolean clear)

Sets whether or not to auto clear the notification when the upload is completed successfully.

Parameters:

clear - true to automatically clear the notification, otherwise false

Returns:

UploadNotificationConfig

setAutoClearOnError

public final UploadNotificationConfig setAutoClearOnError(boolean clear)

Sets whether or not to auto clear the notification when an error happens during upload.

Parameters:

clear - true to automatically clear the notification, otherwise false

Returns:

UploadNotificationConfig

setClearOnAction

public final UploadNotificationConfig setClearOnAction(boolean clear)

Sets whether or not to clear the notification when the user taps on it.

Parameters:

clear - true to clear the notification, otherwise false

Returns:

UploadNotificationConfig

setClickIntent

public final UploadNotificationConfig setClickIntent(Intent clickIntent)

Sets the intent to be executed when the user taps on the notification.

Parameters:

clickIntent - Intent. For example: new Intent(context, YourActivity.class)

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

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel parcel,
                          int arg1)

Specified by:

writeToParcel in interface Parcelable