org.linphone.core

Interface PushNotificationConfig

public interface PushNotificationConfig

Object holding push notification config that will be set in the contact URI
parameters of the Contact header in the REGISTER, if the AccountParams
is configured to allow push notifications, see AccountParams.setPushNotificationAllowed(boolean)
.

This object can be accessed through the AccountParams object, which can
be obtained from your Account object.

Method Summary

Modifier and Type	Method and Description
PushNotificationConfig	clone() Instantiate a new push notification parameters with values from source.
java.lang.String	getBundleIdentifier() Gets the app's bundle identifier for "contact uri parameter".
java.lang.String	getCallSnd() Gets the call_snd for "contact uri parameter".
java.lang.String	getCallStr() Gets the call_str for "contact uri parameter".
java.lang.String	getGroupChatStr() Gets the groupchat_str for "contact uri parameter".
java.lang.String	getMsgSnd() Gets the msg_snd for "contact uri parameter".
java.lang.String	getMsgStr() Gets the msg_str for "contact uri parameter".
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
java.lang.String	getParam() Gets the param for "contact uri parameter".
java.lang.String	getPrid() Gets the prid for "contact uri parameter".
java.lang.String	getProvider() Gets the provider for "contact uri parameter".
java.lang.String	getRemoteToken() Gets the remote token for "contact uri parameter".
java.lang.String	getTeamId() Gets the team id for "contact uri parameter".
java.lang.Object	getUserData() Gets the object stored in this object user's data
java.lang.String	getVoipToken() Gets the voip token for "contact uri parameter".
boolean	isEqual(PushNotificationConfig otherConfig) Checks if two Push Notification Configurations are identical.
void	setBundleIdentifier(java.lang.String bundleIdentifier) Sets the bundle_identifier for "contact uri parameter".
void	setCallSnd(java.lang.String callSnd) Sets the call_snd for "contact uri parameter", specific for remote push notification.
void	setCallStr(java.lang.String callStr) Sets the call_str for "contact uri parameter", specific for remote push notification.
void	setGroupChatStr(java.lang.String groupChatStr) Sets the group_chat_str for "contact uri parameter", specific for remote push notification.
void	setMsgSnd(java.lang.String msgSnd) Sets the msg_snd for "contact uri parameter", specific for remote push notification.
void	setMsgStr(java.lang.String msgStr) Sets the msg_str for "contact uri parameter", specific for remote push notification.
void	setParam(java.lang.String param) Sets the param for "contact uri parameter".
void	setPrid(java.lang.String prid) Sets the prid for "contact uri parameter".
void	setProvider(java.lang.String provider) Sets the provider for "contact uri parameter".
void	setRemoteToken(java.lang.String remoteToken) Sets the remote_token for "contact uri parameter", specific for remote push notification.
void	setTeamId(java.lang.String teamId) Sets the team id for "contact uri parameter".
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
void	setVoipToken(java.lang.String voipToken) Sets the voip_token for "contact uri parameter", specific for voip push notification.
java.lang.String	toString()

Method Detail

getBundleIdentifier

@NonNull
java.lang.String getBundleIdentifier()

Gets the app's bundle identifier for "contact uri parameter".

Returns:

The app's bundle identifier, default value "".

setBundleIdentifier

void setBundleIdentifier(@NonNull
                         java.lang.String bundleIdentifier)

Sets the bundle_identifier for "contact uri parameter".

It's not necessary if param is set. See setParam(java.lang.String).

Parameters:

bundleIdentifier - The new bundle_identifier set for push notification
config.

getCallSnd

@NonNull
java.lang.String getCallSnd()

Gets the call_snd for "contact uri parameter".

Returns:

The call_snd, default value "notes_of_the_optimistic.caf".

setCallSnd

void setCallSnd(@NonNull
                java.lang.String callSnd)

Sets the call_snd for "contact uri parameter", specific for remote push
notification.

Parameters:

callSnd - The new call_snd set for push notification config.

getCallStr

@NonNull
java.lang.String getCallStr()

Gets the call_str for "contact uri parameter".

Returns:

The call_str, default value "IC_MSG".

setCallStr

void setCallStr(@NonNull
                java.lang.String callStr)

Sets the call_str for "contact uri parameter", specific for remote push
notification.

Parameters:

callStr - The new call_str set for push notification config.

getGroupChatStr

@NonNull
java.lang.String getGroupChatStr()

Gets the groupchat_str for "contact uri parameter".

Returns:

The groupchat_str, default value "GC_MSG".

setGroupChatStr

void setGroupChatStr(@NonNull
                     java.lang.String groupChatStr)

Sets the group_chat_str for "contact uri parameter", specific for remote push
notification.

Parameters:

groupChatStr - The new group_chat_str set for push notification config.

getMsgSnd

@NonNull
java.lang.String getMsgSnd()

Gets the msg_snd for "contact uri parameter".

Returns:

The msg_snd, default value "msg.caf".

setMsgSnd

void setMsgSnd(@NonNull
               java.lang.String msgSnd)

Sets the msg_snd for "contact uri parameter", specific for remote push
notification.

Parameters:

msgSnd - The new msg_snd set for push notification config.

getMsgStr

@NonNull
java.lang.String getMsgStr()

Gets the msg_str for "contact uri parameter".

Returns:

The msg_str, default value "IM_MSG".

setMsgStr

void setMsgStr(@NonNull
               java.lang.String msgStr)

Sets the msg_str for "contact uri parameter", specific for remote push
notification.

Parameters:

msgStr - The new msg_str set for push notification config.

getParam

@NonNull
java.lang.String getParam()

Gets the param for "contact uri parameter".

Returns:

The param, default value "".

setParam

void setParam(@NonNull
              java.lang.String param)

Sets the param for "contact uri parameter".

If it's not set, "team_id.bundle_identifier.services" will be used.

Parameters:

param - The new param set for push notification config.

getPrid

@NonNull
java.lang.String getPrid()

Gets the prid for "contact uri parameter".

Returns:

The prid, default value "".

setPrid

void setPrid(@NonNull
             java.lang.String prid)

Sets the prid for "contact uri parameter".

If it's not set, "voip_token&remote_token" will be used.

Parameters:

prid - The new prid set for push notification config.

getProvider

@NonNull
java.lang.String getProvider()

Gets the provider for "contact uri parameter".

Returns:

The provider, default value "".

setProvider

void setProvider(@NonNull
                 java.lang.String provider)

Sets the provider for "contact uri parameter".

If not set, the default value will be used for "contact uri parameter",
"firebase" for android or "apns" for ios.

Parameters:

provider - The new provider set for push notification config.

getRemoteToken

@NonNull
java.lang.String getRemoteToken()

Gets the remote token for "contact uri parameter".

Returns:

The remote token, default value "".

setRemoteToken

void setRemoteToken(@NonNull
                    java.lang.String remoteToken)

Sets the remote_token for "contact uri parameter", specific for remote push
notification.

It's not necessary if prid is set. See setPrid(java.lang.String).

Parameters:

remoteToken - The new remote_token set for push notification config.

getTeamId

@NonNull
java.lang.String getTeamId()

Gets the team id for "contact uri parameter".

Returns:

The team id, default value "ABCD1234".

setTeamId

void setTeamId(@NonNull
               java.lang.String teamId)

Sets the team id for "contact uri parameter".

It's not necessary if param is set. See setParam(java.lang.String).

Parameters:

teamId - The new team id set for push notification config.

getVoipToken

@NonNull
java.lang.String getVoipToken()

Gets the voip token for "contact uri parameter".

Returns:

The voip token, default value "".

setVoipToken

void setVoipToken(@NonNull
                  java.lang.String voipToken)

Sets the voip_token for "contact uri parameter", specific for voip push
notification.

It's not necessary if prid is set. See setPrid(java.lang.String).

Parameters:

voipToken - The new voip_token set for push notification config.

clone

@NonNull
PushNotificationConfig clone()

Instantiate a new push notification parameters with values from source.

Returns:

The newly created PushNotificationConfig object.

isEqual

@NonNull
boolean isEqual(@NonNull
                         PushNotificationConfig otherConfig)

Checks if two Push Notification Configurations are identical.

Parameters:

otherConfig - The PushNotificationConfig object to compare to.

Returns:

True only if the two configurations are identical.

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object