DBTEAMDesktopClientSession

Objective-C

@interface DBTEAMDesktopClientSession
    : DBTEAMDeviceSession <DBSerializable, NSCopying>

Swift

class DBTEAMDesktopClientSession : DBTEAMDeviceSession, DBSerializable, NSCopying

The DesktopClientSession struct.

Information about linked Dropbox desktop client sessions.

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

Instance fields

  • Name of the hosting desktop.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull hostName;

    Swift

    var hostName: String { get }

  • The Dropbox desktop client type.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMDesktopPlatform *_Nonnull clientType;

    Swift

    var clientType: DBTEAMDesktopPlatform { get }

  • The Dropbox client version.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull clientVersion;

    Swift

    var clientVersion: String { get }

  • Information on the hosting platform.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull platform;

    Swift

    var platform: String { get }

  • Whether it’s possible to delete all of the account files upon unlinking.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull isDeleteOnUnlinkSupported;

    Swift

    var isDeleteOnUnlinkSupported: NSNumber { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
            initWithSessionId:(nonnull NSString *)sessionId
                     hostName:(nonnull NSString *)hostName
                   clientType:(nonnull DBTEAMDesktopPlatform *)clientType
                clientVersion:(nonnull NSString *)clientVersion
                     platform:(nonnull NSString *)platform
    isDeleteOnUnlinkSupported:(nonnull NSNumber *)isDeleteOnUnlinkSupported
                    ipAddress:(nullable NSString *)ipAddress
                      country:(nullable NSString *)country
                      created:(nullable NSDate *)created
                      updated:(nullable NSDate *)updated;

    Swift

    init(sessionId: String, hostName: String, clientType: DBTEAMDesktopPlatform, clientVersion: String, platform: String, isDeleteOnUnlinkSupported: NSNumber, ipAddress: String?, country: String?, created: Date?, updated: Date?)

    Parameters

    sessionId

    The session id.
    hostName

    Name of the hosting desktop.
    clientType

    The Dropbox desktop client type.
    clientVersion

    The Dropbox client version.
    platform

    Information on the hosting platform.
    isDeleteOnUnlinkSupported

    Whether it’s possible to delete all of the account files upon unlinking.
    ipAddress

    The IP address of the last activity from this session.
    country

    The country from which the last activity from this session was made.
    created

    The time this session was created.
    updated

    The time of the last activity from this session.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)
            initWithSessionId:(nonnull NSString *)sessionId
                     hostName:(nonnull NSString *)hostName
                   clientType:(nonnull DBTEAMDesktopPlatform *)clientType
                clientVersion:(nonnull NSString *)clientVersion
                     platform:(nonnull NSString *)platform
    isDeleteOnUnlinkSupported:(nonnull NSNumber *)isDeleteOnUnlinkSupported;

    Swift

    init(sessionId: String, hostName: String, clientType: DBTEAMDesktopPlatform, clientVersion: String, platform: String, isDeleteOnUnlinkSupported: NSNumber)

    Parameters

    sessionId

    The session id.
    hostName

    Name of the hosting desktop.
    clientType

    The Dropbox desktop client type.
    clientVersion

    The Dropbox client version.
    platform

    Information on the hosting platform.
    isDeleteOnUnlinkSupported

    Whether it’s possible to delete all of the account files upon unlinking.

    Return Value

    An initialized instance.