DBTEAMRevokeDeviceSessionArg

Objective-C

@interface DBTEAMRevokeDeviceSessionArg : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMRevokeDeviceSessionArg : NSObject, DBSerializable, NSCopying

The RevokeDeviceSessionArg union.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

Constructors

  • Initializes union class with tag state of “web_session”.

    Description of the “web_session” tag state: End an active session.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithWebSession:
        (nonnull DBTEAMDeviceSessionArg *)webSession;

    Swift

    init(webSession: DBTEAMDeviceSessionArg)

    Parameters

    webSession

    End an active session.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “desktop_client”.

    Description of the “desktop_client” tag state: Unlink a linked desktop device.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDesktopClient:
        (nonnull DBTEAMRevokeDesktopClientArg *)desktopClient;

    Swift

    init(desktopClient: DBTEAMRevokeDesktopClientArg)

    Parameters

    desktopClient

    Unlink a linked desktop device.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “mobile_client”.

    Description of the “mobile_client” tag state: Unlink a linked mobile device.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMobileClient:
        (nonnull DBTEAMDeviceSessionArg *)mobileClient;

    Swift

    init(mobileClient: DBTEAMDeviceSessionArg)

    Parameters

    mobileClient

    Unlink a linked mobile device.

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “web_session”.

    Note

    Call this method and ensure it returns true before accessing the webSession property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isWebSession;

    Swift

    func isWebSession() -> Bool

    Return Value

    Whether the union’s current tag state has value “web_session”.

  • Retrieves whether the union’s current tag state has value “desktop_client”.

    Note

    Call this method and ensure it returns true before accessing the desktopClient property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isDesktopClient;

    Swift

    func isDesktopClient() -> Bool

    Return Value

    Whether the union’s current tag state has value “desktop_client”.

  • Retrieves whether the union’s current tag state has value “mobile_client”.

    Note

    Call this method and ensure it returns true before accessing the mobileClient property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isMobileClient;

    Swift

    func isMobileClient() -> Bool

    Return Value

    Whether the union’s current tag state has value “mobile_client”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.