PushNotificationConfig

public class PushNotificationConfig : LinphoneObject

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(). This object can be accessed through the AccountParams object, which can be obtained from your Account object.

  • Undocumented

    Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> PushNotificationConfig

  • Undocumented

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }

  • Sets the bundle_identifier for “contact uri parameter”. It’s not necessary if param is set. See setParam().

    Declaration

    Swift

    public var bundleIdentifier: String { get set }

    Parameters

    bundleIdentifier

    The new bundle_identifier set for push notification config.
    Gets the app’s bundle identifier for “contact uri parameter”.

    Return Value

    The app’s bundle identifier, default value “”.

  • Sets the call_snd for “contact uri parameter”, specific for remote push notification.

    Declaration

    Swift

    public var callSnd: String { get set }

    Parameters

    callSnd

    The new call_snd set for push notification config.
    Gets the call_snd for “contact uri parameter”.

    Return Value

    The call_snd, default value “notes_of_the_optimistic.caf”.

  • Sets the call_str for “contact uri parameter”, specific for remote push notification.

    Declaration

    Swift

    public var callStr: String { get set }

    Parameters

    callStr

    The new call_str set for push notification config.
    Gets the call_str for “contact uri parameter”.

    Return Value

    The call_str, default value “IC_MSG”.

  • Sets the group_chat_str for “contact uri parameter”, specific for remote push notification.

    Declaration

    Swift

    public var groupChatStr: String { get set }

    Parameters

    groupChatStr

    The new group_chat_str set for push notification config.
    Gets the groupchat_str for “contact uri parameter”.

    Return Value

    The groupchat_str, default value “GC_MSG”.

  • Sets the msg_snd for “contact uri parameter”, specific for remote push notification.

    Declaration

    Swift

    public var msgSnd: String { get set }

    Parameters

    msgSnd

    The new msg_snd set for push notification config.
    Gets the msg_snd for “contact uri parameter”.

    Return Value

    The msg_snd, default value “msg.caf”.

  • Sets the msg_str for “contact uri parameter”, specific for remote push notification.

    Declaration

    Swift

    public var msgStr: String { get set }

    Parameters

    msgStr

    The new msg_str set for push notification config.
    Gets the msg_str for “contact uri parameter”.

    Return Value

    The msg_str, default value “IM_MSG”.

  • Sets the param for “contact uri parameter”. If it’s not set, “team_id.bundle_identifier.services” will be used.

    Declaration

    Swift

    public var param: String { get set }

    Parameters

    param

    The new param set for push notification config.
    Gets the param for “contact uri parameter”.

    Return Value

    The param, default value “”.

  • Sets the prid for “contact uri parameter”. If it’s not set, “voip_token&remote_token” will be used.

    Declaration

    Swift

    public var prid: String { get set }

    Parameters

    prid

    The new prid set for push notification config.
    Gets the prid for “contact uri parameter”.

    Return Value

    The prid, default value “”.

  • 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.

    Declaration

    Swift

    public var provider: String { get set }

    Parameters

    provider

    The new provider set for push notification config.
    Gets the provider for “contact uri parameter”.

    Return Value

    The provider, default value “”.

  • Sets the remote_token for “contact uri parameter”, specific for remote push notification. It’s not necessary if prid is set. See setPrid().

    Gets the remote token for “contact uri parameter”.

    Declaration

    Swift

    public var remoteToken: String { get set }

    Parameters

    remoteToken

    The new remote_token set for push notification config.

    Return Value

    The remote token, default value “”.

  • Sets the team id for “contact uri parameter”. It’s not necessary if param is set. See setParam().

    Declaration

    Swift

    public var teamId: String { get set }

    Parameters

    teamId

    The new team id set for push notification config.
    Gets the team id for “contact uri parameter”.

    Return Value

    The team id, default value “ABCD1234”.

  • Sets the voip_token for “contact uri parameter”, specific for voip push notification. It’s not necessary if prid is set. See setPrid().

    Declaration

    Swift

    public var voipToken: String { get set }

    Parameters

    voipToken

    The new voip_token set for push notification config.
    Gets the voip token for “contact uri parameter”.

    Return Value

    The voip token, default value “”.

  • Instantiate a new push notification parameters with values from source.

    Declaration

    Swift

    public func clone() -> PushNotificationConfig?

    Return Value

    The newly created PushNotificationConfig object.

  • Checks if two Push Notification Configurations are identical.

    Declaration

    Swift

    public func isEqual(otherConfig: PushNotificationConfig) -> Bool

    Parameters

    otherConfig

    The PushNotificationConfig object to compare to.

    Return Value

    True only if the two configurations are identical.