DBCOMMONRootInfo

Objective-C

@interface DBCOMMONRootInfo : NSObject <DBSerializable, NSCopying>

Swift

class DBCOMMONRootInfo : NSObject, DBSerializable, NSCopying

The RootInfo struct.

Information about current user’s root.

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

Instance fields

  • The namespace ID for user’s root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as homeNamespaceId in DBCOMMONRootInfo.

    Declaration

    Objective-C

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

    Swift

    var rootNamespaceId: String { get }

  • The namespace ID for user’s home namespace.

    Declaration

    Objective-C

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

    Swift

    var homeNamespaceId: String { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithRootNamespaceId:(nonnull NSString *)rootNamespaceId
            homeNamespaceId:(nonnull NSString *)homeNamespaceId;

    Swift

    init(rootNamespaceId: String, homeNamespaceId: String)

    Parameters

    rootNamespaceId

    The namespace ID for user’s root namespace. It will be the namespace ID of the shared team root if the user is member of a team with a separate team root. Otherwise it will be same as homeNamespaceId in DBCOMMONRootInfo.
    homeNamespaceId

    The namespace ID for user’s home namespace.

    Return Value

    An initialized instance.