MoEngageSDKAnalytics

@objc
public class MoEngageSDKAnalytics : NSObject, @unchecked Sendable

Class to track data on the MoEngage Platform.


                    
                    
                    sharedInstance

Singleton class instance

Declaration

Swift

@objc
public static var sharedInstance: MoEngageSDKAnalytics { get }


                    
                    
                    trackEvent(_:withProperties:forAppID:isolation:file:line:column:)

Track an event.

Declaration

Swift

@discardableResult
public func trackEvent(
    _ name: String, withProperties properties: MoEngageProperties? = nil,
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageTrackEventTask

Parameters

`name`	event name
`properties`	attributes associated with the event
`appID`	MoEngage account identifier; `nil` for the default instance

Return Value

MoEngageTrackEventTask. onSuccess fires once the event is accepted into the local batch; the result carries acceptedProperties + droppedPropertyKeys. onFailure reasons: .featureDisabled (analytics off / opted out), .invalidParameters (event name blacklisted by remote config — the feature is enabled, this specific name isn’t accepted), .sdkNotInitialized, or .unknownError for an unspecified internal failure.


                    
                    
                    flush(forAppID:isolation:file:line:column:withCompletionBlock:)

Sync the tracked events instantaneously for Secondary instance

Declaration

Swift

@available(*, deprecated, message: "Use the typed-task variant returning MoEngageFlushTask — observe via onSuccess / onFailure / result(﹚.")
@_disfavoredOverload
public func flush(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column,
    withCompletionBlock completionBlock: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters

`appID`	MoEngage Account Identifier.
`completionBlock`	completion block to be called after events are flushed out


                    
                    
                    flush(forAppID:isolation:file:line:column:)

Sync the tracked events instantaneously.

Declaration

Swift

@discardableResult
public func flush(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageFlushTask

Parameters


                                appID

MoEngage Account Identifier.

Return Value

A MoEngageFlushTask. onSuccess fires when the batch sync has been server-acknowledged. onFailure fires with .networkError when the sync attempt failed (network / server / auth), or .sdkNotInitialized when no SDK instance is registered for appID. Marked @discardableResult so existing fire-and-forget callers compile unchanged.


                    
                    
                    processURL(_:isolation:file:line:column:)

Update source based on query params of the URL.

Declaration

Swift

@discardableResult
public func processURL(
    _ url: URL?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageProcessURLTask

Parameters

url

URL that contains source information in query params.

Return Value

MoEngageProcessURLTask carrying MoEngageProcessURLResult whose wasHandled field indicates whether the SDK actually processed the URL (true) or deferred to auto-tracking / a swizzled callback / nil-URL short-circuit (false). Customers using onFailure will receive .invalidParameters when url is nil.


                    
                    
                    setAlias(_:forAppID:isolation:file:line:column:)

Set an alias to update the existing Unique Id.

Declaration

Swift

@discardableResult
public func setAlias(
    _ alias: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`alias`	identifier
`appID`	MoEngage account identifier; `nil` for the default instance

Return Value

MoEngageSetUserAttributeTask. onSuccess fires after dispatch (including the dedup case). onFailure fires with .invalidParameters when the alias is rejected, or .sdkNotInitialized.


                    
                    
                    setUserAttribute(_:withAttributeName:level:variant:forAppID:isolation:file:line:column:)

Set a custom user attribute at the given level. Leaf method for the setUserAttribute* family — most convenience wrappers delegate here.

Declaration

Swift

@discardableResult
public func setUserAttribute(
    _ value: (any Sendable)?, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default,
    variant: MoEngageUserAttributeVariant = .standard,
    forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name
`level`	project- or portfolio-level scope
`appID`	MoEngage account identifier; `nil` for the default instance

Return Value

MoEngageSetUserAttributeTask. onSuccess fires when the attribute is persisted or already matched the cache (dedup). onFailure fires with .invalidParameters on rejection, or .sdkNotInitialized.


                    
                    
                    resetUser(forAppID:isolation:file:line:column:withCompletionBlock:)

Invalidates the existing sessions and user attributes and treats all actions performed by the user as a new user after this method is called

Declaration

Swift

@available(*, deprecated, message: "Use the typed-task variant returning MoEngageResetUserTask — observe via onSuccess / onFailure / result(﹚.")
@_disfavoredOverload
public func resetUser(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column,
    withCompletionBlock completionBlock: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters

`appID`	optional account identifier.
`completionBlock`	Returns true if reset is successful else false


                    
                    
                    resetUser(forAppID:isolation:file:line:column:)

Invalidate existing sessions and user attributes; subsequent actions are tracked as a new user.

Declaration

Swift

@discardableResult
public func resetUser(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageResetUserTask

Parameters


                                appID

optional account identifier.

Return Value

MoEngageResetUserTask. onSuccess fires after dispatch (including benign no-op cases like extension context or data-tracking opted out); onFailure fires with .sdkNotInitialized.


                    
                    
                    setDelegate(delegate:forAppID:isolation:file:line:column:)

Set the Analytics delegate to get the callback for various Analytics events

Declaration

Swift

public func setDelegate(
    delegate: MoEngageAnalyticsCallBack, forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
)

Parameters

`delegate`	Instance that confirms to `MoEngageAnalyticsCallBack`
`appID`	Optional Account Identifier


                    
                    
                    setDeviceAttribute(_:withName:forWorkspaceId:isolation:file:line:column:)

Set custom device attribute for workspace.

Supported value data types are:

Number (Int, Double, Float)
String
Boolean

Date

Date (ISO 8601 String)

Declaration

Swift

@available(iOSApplicationExtension, unavailable)
@discardableResult
public func setDeviceAttribute(
    _ value: any Sendable, withName attributeName: String, forWorkspaceId workspaceId: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetDeviceAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name
`workspaceId`	MoEngage Workspace identifier


                    
                    
                    appStatus(_:forAppID:isolation:file:line:column:)

This method tells the SDK whether it is a fresh install or an existing application was updated.

Declaration

Swift

@discardableResult
public func appStatus(
    _ appStatus: MoEngageAppStatus,
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetAppStatusTask

Parameters

`appStatus`	Enum of type `MoEngageAppStatus`
`appID`	MoEngage Account Identifier.


                    
                    
                    enableDataTracking(forAppID:isolation:file:line:column:)

API to enable data tracking.

Declaration

Swift

@discardableResult
public func enableDataTracking(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    disableDataTracking(forAppID:isolation:file:line:column:)

Optionally opt-out of data tracking. When data tracking is opted out no custom event or user attribute is tracked on MoEngage Platform.

Declaration

Swift

@discardableResult
public func disableDataTracking(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    enableIDFATracking(forAppID:isolation:file:line:column:)

Enable IDFA tracking

Declaration

Swift

@discardableResult
public func enableIDFATracking(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    disableIDFATracking(forAppID:isolation:file:line:column:)

Disable IDFA tracking

Declaration

Swift

@discardableResult
public func disableIDFATracking(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    enableIDFVTracking(forAppID:isolation:file:line:column:)

Enable IDFV tracking

Declaration

Swift

@discardableResult
public func enableIDFVTracking(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    disableIDFVTracking(forAppID:isolation:file:line:column:)

Disable IDFV tracking

Declaration

Swift

@discardableResult
public func disableIDFVTracking(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    trackLocale(forAppID:isolation:file:line:column:)

Tracks device locale.

Declaration

Swift

@discardableResult
public func trackLocale(
    forAppID appID: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageTrackDeviceLocaleTask

Parameters


                                appID

MoEngage Account identifier

Track Event


                    
                    
                    trackEvent(_:withProperties:)

Track Event for Default MoEngage Instance.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func trackEvent(
    _ name: String, withProperties properties: MoEngageProperties? = nil
) -> MoEngageTrackEventTask

Parameters

`name`	name of the event
`properties`	instance of type `MoEngageProperties` that contains attributes related to event


                    
                    
                    trackEvent(_:withProperties:forAppID:)

Track Event for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func trackEvent(
    _ name: String, withProperties properties: MoEngageProperties? = nil, forAppID appID: String? = nil
) -> MoEngageTrackEventTask

Parameters

`name`	event name
`properties`	instance of type `MoEngageProperties` that contains attributes related to event
`appID`	MoEngage Account Identifier.

Track App Status


                    
                    
                    appStatus(_:forAppID:)

This method tells the SDK whether it is a fresh install or an existing application was updated.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func appStatus(
    _ appStatus: MoEngageAppStatus,
    forAppID appID: String? = nil
) -> MoEngageSetAppStatusTask

Parameters

`appStatus`	Enum of type `MoEngageAppStatus`
`appID`	MoEngage Account Identifier.


                    
                    
                    appStatus(_:)

This method tells the default SDK instance whether it is a fresh install or an existing application was updated.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func appStatus(_ appStatus: MoEngageAppStatus) -> MoEngageSetAppStatusTask

Parameters


                                appStatus

Enum of type MoEngageAppStatus

Reset User


                    
                    
                    resetUser(forAppID:withCompletionBlock:)

Invalidates the existing sessions and user attributes (deprecated — completion-block variant).

Declaration

Swift

@available(*, deprecated, message: "Use resetUser(forAppID:﹚ returning MoEngageResetUserTask — observe success/failure via .onSuccess / .onFailure / .result(﹚.")
@_disfavoredOverload
@objc
public func resetUser(
    forAppID appID: String? = nil,
    withCompletionBlock completionBlock: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters

`appID`	optional account identifier.
`completionBlock`	Returns true if reset is successful else false

resetUser()
Invalidates the existing sessions and user attributes for the default instance.
Declaration
Swift

@discardableResult @_disfavoredOverload @objc public func resetUser() -> MoEngageResetUserTask
Return Value

MoEngageResetUserTask carrying a MoEngageResetUserResult on success.


                    
                    
                    resetUser(withCompletionBlock:)

Invalidates the existing sessions and user attributes for the default instance (deprecated — completion-block variant).

Declaration

Swift

@available(*, deprecated, message: "Use resetUser(﹚ returning MoEngageResetUserTask — observe success/failure via .onSuccess / .onFailure / .result(﹚.")
@_disfavoredOverload
@objc
public func resetUser(
    withCompletionBlock completionBlock: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters


                                completionBlock

Returns true if reset is successful else false


                    
                    
                    resetUser(forAppID:)

Invalidates the existing sessions and user attributes.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func resetUser(forAppID appID: String? = nil) -> MoEngageResetUserTask

Parameters


                                appID

MoEngage Account identifier

Return Value

MoEngageResetUserTask carrying a MoEngageResetUserResult on success.

OptOut Methods


                    
                    
                    enableDataTracking(forAppID:)

API to enable data tracking.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func enableDataTracking(forAppID appID: String? = nil) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    enableDataTracking()

API to enable data tracking.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func enableDataTracking() -> MoEngageTrackingToggleTask


                    
                    
                    disableDataTracking(forAppID:)

Optionally opt-out of data tracking. When data tracking is opted out no custom event or user attribute is tracked on MoEngage Platform.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func disableDataTracking(forAppID appID: String? = nil) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier

disableDataTracking()
Optionally opt-out of data tracking. When data tracking is opted out no custom event or user attribute is tracked on MoEngage Platform.
Declaration
Swift

@discardableResult @_disfavoredOverload @objc public func disableDataTracking() -> MoEngageTrackingToggleTask


                    
                    
                    enableIDFATracking(forAppID:)

Enable IDFA tracking

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func enableIDFATracking(forAppID appID: String? = nil) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    enableIDFATracking()

Enable IDFA tracking

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func enableIDFATracking() -> MoEngageTrackingToggleTask


                    
                    
                    disableIDFATracking(forAppID:)

Disable IDFA tracking

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func disableIDFATracking(forAppID appID: String? = nil) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    disableIDFATracking()

Disable IDFA tracking

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func disableIDFATracking() -> MoEngageTrackingToggleTask


                    
                    
                    enableIDFVTracking(forAppID:)

Enable IDFV tracking

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func enableIDFVTracking(forAppID appID: String? = nil) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    enableIDFVTracking()

Enable IDFV tracking

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func enableIDFVTracking() -> MoEngageTrackingToggleTask


                    
                    
                    disableIDFVTracking(forAppID:)

Disable IDFV tracking

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func disableIDFVTracking(forAppID appID: String? = nil) -> MoEngageTrackingToggleTask

Parameters


                                appID

MoEngage Account identifier


                    
                    
                    disableIDFVTracking()

Disable IDFV tracking

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func disableIDFVTracking() -> MoEngageTrackingToggleTask

Track Locale


                    
                    
                    trackLocale()

Tracks device locale.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func trackLocale() -> MoEngageTrackDeviceLocaleTask


                    
                    
                    trackLocale(forAppID:)

Tracks device locale.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func trackLocale(forAppID appID: String? = nil) -> MoEngageTrackDeviceLocaleTask

Parameters


                                appID

MoEngage Account identifier

Set Delegate


                    
                    
                    setDelegate(delegate:forAppID:)

Set the Analytics delegate to get the callback for various Analytics events

Declaration

Swift

@_disfavoredOverload
@objc
public func setDelegate(delegate: MoEngageAnalyticsCallBack, forAppID appID: String? = nil)

Parameters

`delegate`	Instance that confirms to `MoEngageAnalyticsCallBack`
`appID`	Optional Account Identifier

Flush Events


                    
                    
                    flush(forAppID:withCompletionBlock:)

Sync the tracked events instantaneously for Secondary instance.

Declaration

Swift

@available(*, deprecated, message: "Use flush(forAppID:﹚ returning MoEngageFlushTask — observe success/failure via .onSuccess / .onFailure / .result(﹚.")
@_disfavoredOverload
@objc
public func flush(
    forAppID appID: String? = nil,
    withCompletionBlock completionBlock: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters

`appID`	MoEngage Account Identifier.
`completionBlock`	completion block to be called after events are flushed out

flush()
Sync the tracked events instantaneously for Default instance.
Declaration
Swift

@discardableResult @_disfavoredOverload @objc public func flush() -> MoEngageFlushTask
Return Value

MoEngageFlushTask carrying a MoEngageFlushResult on server-acknowledged sync.


                    
                    
                    flush(forAppID:)

Sync the tracked events instantaneously for Secondary instance.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func flush(forAppID appID: String? = nil) -> MoEngageFlushTask

Parameters


                                appID

MoEngage Account identifier

Return Value

MoEngageFlushTask carrying a MoEngageFlushResult on server-acknowledged sync.


                    
                    
                    flush(withCompletionBlock:)

Sync the tracked events instantaneously for Default instance (deprecated — completion-block variant).

Declaration

Swift

@available(*, deprecated, message: "Use flush(﹚ returning MoEngageFlushTask — observe success/failure via .onSuccess / .onFailure / .result(﹚.")
@_disfavoredOverload
@objc
public func flush(
    withCompletionBlock completionBlock: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters


                                completionBlock

completion block to be called after events are flushed out


                    
                    
                    processURL(_:)

Update source based on query params of the URL.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func processURL(_ url: URL?) -> MoEngageProcessURLTask

Parameters

url

URL that contains source information in query params

Return Value

MoEngageProcessURLTask — see the Swift overload on MoEngageSDKAnalytics for resolution semantics.

Date Attributes


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:forAppID:)

Set epoch time for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:forAppID:isolation:file:line:column:)

Set epoch time for Secondary instance

Declaration

Swift

@discardableResult
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:)

Set epoch time for Default instance

Declaration

Swift

@discardableResult
@objc
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String
) -> MoEngageSetUserAttributeTask

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String


                    
                    
                    setUserAttributeDate(_:withAttributeName:forAppID:)

Set User attribute date for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`date`	attribute value as Date
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeDate(_:withAttributeName:forAppID:isolation:file:line:column:)

Set User attribute date for Secondary instance

Declaration

Swift

@discardableResult
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`date`	attribute value as Date
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeDate(_:withAttributeName:)

Set User attribute date for Default instance

Declaration

Swift

@discardableResult
@objc
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String
) -> MoEngageSetUserAttributeTask

Parameters

`date`	attribute value as Date
`attributeName`	attribute name


                    
                    
                    setUserAttributeISODate(_:withAttributeName:forAppID:)

Set User attribute ISO date for Secondary instance

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`dateString`	ISO date of type string
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeISODate(_:withAttributeName:forAppID:isolation:file:line:column:)

Set User attribute ISO date for Secondary instance

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@discardableResult
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`dateString`	ISO date of type string
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeISODate(_:withAttributeName:)

Set User attribute ISO date

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@discardableResult
@objc
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String
) -> MoEngageSetUserAttributeTask

Parameters

`dateString`	ISO date of type string
`attributeName`	attribute name


                    
                    
                    setDateOfBirth(_:forAppID:)

Set User Date of Birth for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setDateOfBirth(_ dob: Date, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`dob`	Date of Birth passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setDateOfBirth(_:forAppID:isolation:file:line:column:)

Set User Date of Birth for Secondary instance

Declaration

Swift

@discardableResult
public func setDateOfBirth(
    _ dob: Date, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`dob`	Date of Birth passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setDateOfBirth(_:)

Set User Date of Birth

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setDateOfBirth(_ dob: Date) -> MoEngageSetUserAttributeTask

Parameters

dob

Date of Birth passed by user


                    
                    
                    setDateOfBirthInISO(_:forAppID:)

Set user Date of Birth ISO format for Secondary instance

Note

ISO format accepted yyyy-MM-dd’T'HH:mm:ss.SSS'Z’ / yyyy-MM-dd’T'HH:mm:ss'Z’

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setDateOfBirthInISO(
    _ dateString: String, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`dateString`	attribute value accepted in ISO format
`appID`	MoEngage Account identifier


                    
                    
                    setDateOfBirthInISO(_:forAppID:isolation:file:line:column:)

Set user Date of Birth ISO format for Secondary instance

Note

ISO format accepted yyyy-MM-dd’T'HH:mm:ss.SSS'Z’ / yyyy-MM-dd’T'HH:mm:ss'Z’

Declaration

Swift

@discardableResult
public func setDateOfBirthInISO(
    _ dateString: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`dateString`	attribute value accepted in ISO format
`appID`	MoEngage Account identifier


                    
                    
                    setDateOfBirthInISO(_:)

Method to set user date of birth ISO format

Note

ISO format accepted yyyy-MM-dd’T'HH:mm:ss.SSS'Z’ / yyyy-MM-dd’T'HH:mm:ss'Z’

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setDateOfBirthInISO(_ dateString: String) -> MoEngageSetUserAttributeTask

Parameters


                                dateString

attribute value accepted in ISO format

Location Attributes


                    
                    
                    setLocation(_:withAttributeName:forAppID:)

Set custom user location for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String,
    forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attribute name
`appID`	MoEngage Account Identifier


                    
                    
                    setLocation(_:withAttributeName:forAppID:isolation:file:line:column:)

Set custom user location for Secondary instance

Declaration

Swift

@discardableResult
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String,
    forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attribute name
`appID`	MoEngage Account Identifier


                    
                    
                    setLocation(_:withAttributeName:)

Set custom user location

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String
) -> MoEngageSetUserAttributeTask

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attributeName name


                    
                    
                    setLocation(_:forAppID:)

Set user location for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setLocation(
    _ location: MoEngageGeoLocation, forAppID appID: String? = nil
) -> MoEngageSetUserAttributeTask

Parameters

`location`	Location passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setLocation(_:forAppID:isolation:file:line:column:)

Set user location for Secondary instance

Declaration

Swift

@discardableResult
public func setLocation(
    _ location: MoEngageGeoLocation, forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`location`	Location passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setLocation(_:)

Set user location

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setLocation(_ location: MoEngageGeoLocation) -> MoEngageSetUserAttributeTask

Parameters


                                location

Location passed by user

Portfolio User Attribute APIs with Level Support


                    
                    
                    setUserAttribute(_:withAttributeName:level:forAppID:)

Set custom user attribute for Secondary instance with level

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttribute(
    _ value: (any Sendable)?, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttribute(_:withAttributeName:level:)

Set custom user attribute for Default instance with level

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttribute(
    _ value: (any Sendable)?, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default
) -> MoEngageSetUserAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name
`level`	level at which attribute should be set


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:level:forAppID:)

Set epoch time for Secondary instance with level

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:level:forAppID:isolation:file:line:column:)

Set epoch time for Secondary instance with level

Declaration

Swift

@discardableResult
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeEpochTime(_:withAttributeName:level:)

Set epoch time for Default instance with level

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeEpochTime(
    _ dateEpoch: Double, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default
) -> MoEngageSetUserAttributeTask

Parameters

`dateEpoch`	Epoch date of type double
`attributeName`	attribute name of type String
`level`	level at which attribute should be set


                    
                    
                    setUserAttributeDate(_:withAttributeName:level:forAppID:)

Set User attribute date for Secondary instance with level

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`date`	attribute value as Date
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeDate(_:withAttributeName:level:forAppID:isolation:file:line:column:)

Set User attribute date for Secondary instance with level

Declaration

Swift

@discardableResult
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`date`	attribute value as Date
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeDate(_:withAttributeName:level:)

Set User attribute date for Default instance with level

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeDate(
    _ date: Date, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default
) -> MoEngageSetUserAttributeTask

Parameters

`date`	attribute value as Date
`attributeName`	attribute name
`level`	level at which attribute should be set


                    
                    
                    setUserAttributeISODate(_:withAttributeName:level:forAppID:)

Set User attribute ISO date for Secondary instance with level

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`dateString`	ISO date of type string
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeISODate(_:withAttributeName:level:forAppID:isolation:file:line:column:)

Set User attribute ISO date for Secondary instance with level

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@discardableResult
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`dateString`	ISO date of type string
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage account identifier


                    
                    
                    setUserAttributeISODate(_:withAttributeName:level:)

Set User attribute ISO date for Default instance with level

Note

ISO accepted formats are yyyy-MM-dd’T'HH:mm:ss'Z’/yyyy-MM-dd’T'HH:mm:ss.SSS'Z’

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttributeISODate(
    _ dateString: String, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default
) -> MoEngageSetUserAttributeTask

Parameters

`dateString`	ISO date of type string
`attributeName`	attribute name
`level`	level at which attribute should be set


                    
                    
                    setLocation(_:withAttributeName:level:forAppID:)

Set custom user location for Secondary instance with level

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage Account Identifier


                    
                    
                    setLocation(_:withAttributeName:level:forAppID:isolation:file:line:column:)

Set custom user location for Secondary instance with level

Declaration

Swift

@discardableResult
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attribute name
`level`	level at which attribute should be set
`appID`	MoEngage Account Identifier


                    
                    
                    setLocation(_:withAttributeName:level:)

Set custom user location for Default instance with level

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setLocation(
    _ location: MoEngageGeoLocation, withAttributeName attributeName: String,
    level: MoEngageUserAttributeLevel = .default
) -> MoEngageSetUserAttributeTask

Parameters

`location`	`MoEngageGeoLocation` instance
`attributeName`	attribute name
`level`	level at which attribute should be set

User Attributes


                    
                    
                    setUserAttribute(_:withAttributeName:forAppID:)

Set custom user attribute for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUserAttribute(
    _ value: (any Sendable)?, withAttributeName attributeName: String, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttribute(_:withAttributeName:forAppID:isolation:file:line:column:)

Set custom user attribute for Secondary instance

Declaration

Swift

@discardableResult
public func setUserAttribute(
    _ value: (any Sendable)?, withAttributeName attributeName: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name
`appID`	MoEngage account identifier


                    
                    
                    setUserAttribute(_:withAttributeName:)

Set custom user attribute for Default instance

Declaration

Swift

@discardableResult
@objc
public func setUserAttribute(
    _ value: (any Sendable)?, withAttributeName attributeName: String
) -> MoEngageSetUserAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name


                    
                    
                    setAlias(_:forAppID:)

Set an Alias to update the existing Unique Id for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setAlias(_ alias: String, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`alias`	identifier
`appID`	MoEngage Account Identifier


                    
                    
                    setAlias(_:)

Set an Alias to update the existing Unique Id for Default instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setAlias(_ alias: String) -> MoEngageSetUserAttributeTask

Parameters


                                alias

identifier


                    
                    
                    setUniqueID(_:forAppID:)

Set unique ID for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUniqueID(_ uniqueID: String, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`uniqueID`	Unique ID
`appID`	MoEngage Account identifier


                    
                    
                    setUniqueID(_:forAppID:isolation:file:line:column:)

Set unique ID for Secondary instance

Declaration

Swift

@discardableResult
public func setUniqueID(
    _ uniqueID: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`uniqueID`	Unique ID
`appID`	MoEngage Account identifier


                    
                    
                    setUniqueID(_:)

Set unique ID for Default instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setUniqueID(_ uniqueID: String) -> MoEngageSetUserAttributeTask

Parameters


                                uniqueID

Unique ID


                    
                    
                    setEmailID(_:forAppID:)

Set Email ID for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setEmailID(_ emailID: String, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`emailID`	emailID value.
`appID`	MoEngage Account identifier


                    
                    
                    setEmailID(_:forAppID:isolation:file:line:column:)

Set Email ID for Secondary instance

Declaration

Swift

@discardableResult
public func setEmailID(
    _ emailID: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`emailID`	emailID value.
`appID`	MoEngage Account identifier


                    
                    
                    setEmailID(_:)

Set Email ID

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setEmailID(_ emailID: String) -> MoEngageSetUserAttributeTask

Parameters


                                emailID

emailID value.


                    
                    
                    setName(_:forAppID:)

Set user name for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setName(_ userName: String, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`userName`	User Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setName(_:forAppID:isolation:file:line:column:)

Set user name for Secondary instance

Declaration

Swift

@discardableResult
public func setName(
    _ userName: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`userName`	User Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setName(_:)

Set user name

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setName(_ userName: String) -> MoEngageSetUserAttributeTask

Parameters


                                userName

User Name value passed by user


                    
                    
                    setFirstName(_:forAppID:)

Set User first name for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setFirstName(_ firstName: String, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`firstName`	First Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setFirstName(_:forAppID:isolation:file:line:column:)

Set User first name for Secondary instance

Declaration

Swift

@discardableResult
public func setFirstName(
    _ firstName: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`firstName`	First Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setFirstName(_:)

Set User first name

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setFirstName(_ firstName: String) -> MoEngageSetUserAttributeTask

Parameters


                                firstName

First Name value passed by user


                    
                    
                    setLastName(_:forAppID:)

Set User last name for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setLastName(_ lastName: String, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`lastName`	Last Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setLastName(_:forAppID:isolation:file:line:column:)

Set User last name for Secondary instance

Declaration

Swift

@discardableResult
public func setLastName(
    _ lastName: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`lastName`	Last Name value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setLastName(_:)

Set User last name

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setLastName(_ lastName: String) -> MoEngageSetUserAttributeTask

Parameters


                                lastName

Last Name value passed by user


                    
                    
                    setMobileNumber(_:forAppID:)

Set mobile number for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setMobileNumber(_ mobileNum: String, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`mobileNum`	Mobile Number value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setMobileNumber(_:forAppID:isolation:file:line:column:)

Set mobile number for Secondary instance

Declaration

Swift

@discardableResult
public func setMobileNumber(
    _ mobileNum: String, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`mobileNum`	Mobile Number value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setMobileNumber(_:)

Set mobile number

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setMobileNumber(_ mobileNum: String) -> MoEngageSetUserAttributeTask

Parameters


                                mobileNum

Mobile Number value passed by user


                    
                    
                    setGender(_:forAppID:)

Set User gender for Secondary instance

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setGender(_ gender: MoEngageUserGender, forAppID appID: String?) -> MoEngageSetUserAttributeTask

Parameters

`gender`	Gender value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setGender(_:forAppID:isolation:file:line:column:)

Set User gender for Secondary instance

Declaration

Swift

@discardableResult
public func setGender(
    _ gender: MoEngageUserGender, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`gender`	Gender value passed by user
`appID`	MoEngage Account identifier


                    
                    
                    setGender(_:)

Set User gender

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func setGender(_ gender: MoEngageUserGender) -> MoEngageSetUserAttributeTask

Parameters


                                gender

Gender value passed by user


                    
                    
                    trackUserPushPreference(_:forAppID:)

Track user attribute push preference

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
public func trackUserPushPreference(
    _ isPushEnabled: Bool, forAppID appID: String?
) -> MoEngageSetUserAttributeTask

Parameters

`isPushEnabled`	true if Push is enabled else false.
`appID`	MoEngage Account identifier


                    
                    
                    trackUserPushPreference(_:forAppID:isolation:file:line:column:)

Track user attribute push preference

Declaration

Swift

@discardableResult
public func trackUserPushPreference(
    _ isPushEnabled: Bool, forAppID appID: String?,
    isolation `actor`: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageSetUserAttributeTask

Parameters

`isPushEnabled`	true if Push is enabled else false.
`appID`	MoEngage Account identifier


                    
                    
                    setDeviceAttribute(_:withName:forWorkspaceId:)

Set custom device attribute for workspace.

Supported value data types are:

Number (Int, Double, Float)
String
Boolean

Date

Date (ISO 8601 String)

Declaration

Swift

@available(iOSApplicationExtension, unavailable)
@discardableResult
func setDeviceAttribute(
    _ value: any Sendable, withName attributeName: String, forWorkspaceId workspaceId: String? = nil
) -> MoEngageSetDeviceAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name
`workspaceId`	MoEngage Workspace identifier


                    
                    
                    setDeviceAttribute(_:withName:)

Set custom device attribute for Default instance.

Supported value data types are:

Number (Int, Double, Float)
String
Boolean

Date

Date (ISO 8601 String)

Declaration

Swift

@available(iOSApplicationExtension, unavailable)
@discardableResult
func setDeviceAttribute(
    _ value: any Sendable, withName attributeName: String
) -> MoEngageSetDeviceAttributeTask

Parameters

`value`	attribute value
`attributeName`	attribute name


                    
                    
                    identifyUser(identities:workspaceId:)

Add unique identities to current user.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
func identifyUser(identities: [String : String], workspaceId: String? = nil) -> MoEngageIdentifyUserTask

Parameters

`identities`	The identities uniquely identifying current user.
`workspaceId`	MoEngage Workspace Identifier.


                    
                    
                    identifyUser(identity:workspaceId:)

Add unique identifier uid to current user.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
func identifyUser(identity: String, workspaceId: String? = nil) -> MoEngageIdentifyUserTask

Parameters

`identity`	The identifier uniquely identifying current user.
`workspaceId`	MoEngage Workspace Identifier.

Get user identities


                    
                    
                    getUserIdentities(workspaceId:completion:)

Get all the identities set for current user (deprecated — completion-block variant).

Declaration

Swift

@available(*, deprecated, message: "Use getUserIdentities(workspaceId:﹚ returning MoEngageGetUserIdentitiesTask — observe identities via .onSuccess / .result(﹚.")
@_disfavoredOverload
@objc
func getUserIdentities(
    workspaceId: String? = nil,
    completion: @escaping @MainActor(unsafe) ([String: String]) -> Void
)

Parameters

`workspaceId`	MoEngage Workspace Identifier.
`completion`	The block where identities will be provided on main thread.


                    
                    
                    getUserIdentities(workspaceId:)

Get all the identities set for current user.

Declaration

Swift

@discardableResult
@_disfavoredOverload
@objc
func getUserIdentities(workspaceId: String? = nil) -> MoEngageGetUserIdentitiesTask

Parameters


                                workspaceId

MoEngage Workspace Identifier.

Return Value

MoEngageGetUserIdentitiesTask carrying a MoEngageGetUserIdentitiesResult with the current identity map on success.


                    
                    
                    identifyUser(identities:workspaceId:isolation:file:line:column:)

Add unique identities to the current user.

Declaration

Swift

@discardableResult
public func identifyUser(
    identities: [String: String], workspaceId: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageIdentifyUserTask

Parameters

`identities`	The identities uniquely identifying the current user.
`workspaceId`	MoEngage workspace identifier.

Return Value

MoEngageIdentifyUserTask. onSuccess fires after dispatch (including benign no-op cases like extension context or unchanged identities). onFailure fires with .sdkNotInitialized, or .featureDisabled when data tracking is disabled or the user is opted out.


                    
                    
                    identifyUser(identity:workspaceId:isolation:file:line:column:)

Add unique identifier uid to current user.

Declaration

Swift

@discardableResult
public func identifyUser(
    identity: String, workspaceId: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageIdentifyUserTask

Parameters

`identity`	The identifier uniquely identifying current user.
`workspaceId`	MoEngage Workspace Identifier.


                    
                    
                    getUserIdentities(workspaceId:isolation:file:line:column:)

Get all the identities set for current user.

Declaration

Swift

@discardableResult
public func getUserIdentities(
    workspaceId: String? = nil,
    isolation: isolated (any Actor)? = #isolation,
    file: StaticString = #fileID,
    line: UInt = #line,
    column: UInt = #column
) -> MoEngageGetUserIdentitiesTask

Parameters


                                workspaceId

MoEngage Workspace Identifier.

Return Value

A MoEngageGetUserIdentitiesTask. onSuccess fires with the current identity map. onFailure fires with .sdkNotInitialized when no SDK instance is registered for workspaceId.