DBTEAMLOGTeamEvent

Objective-C

@interface DBTEAMLOGTeamEvent : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLOGTeamEvent : NSObject, DBSerializable, NSCopying

The TeamEvent struct.

An audit log event.

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 Dropbox timestamp representing when the action was taken.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull timestamp;

    Swift

    var timestamp: Date { get }

  • The category that this type of action belongs to.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMLOGEventCategory *_Nonnull eventCategory;

    Swift

    var eventCategory: DBTEAMLOGEventCategory { get }

  • The entity who actually performed the action. Might be missing due to historical data gap.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBTEAMLOGActorLogInfo *actor;

    Swift

    var actor: DBTEAMLOGActorLogInfo? { get }

  • The origin from which the actor performed the action including information about host, ip address, location, session, etc. If the action was performed programmatically via the API the origin represents the API client.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBTEAMLOGOriginLogInfo *origin;

    Swift

    var origin: DBTEAMLOGOriginLogInfo? { get }

  • True if the action involved a non team member either as the actor or as one of the affected users. Might be missing due to historical data gap.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *involveNonTeamMember;

    Swift

    var involveNonTeamMember: NSNumber? { get }

  • The user or team on whose behalf the actor performed the action. Might be missing due to historical data gap.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBTEAMLOGContextLogInfo *context;

    Swift

    var context: DBTEAMLOGContextLogInfo? { get }

  • Zero or more users and/or groups that are affected by the action. Note that this list doesn’t include any actors or users in context.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSArray<DBTEAMLOGParticipantLogInfo *> *participants;

    Swift

    var participants: [DBTEAMLOGParticipantLogInfo]? { get }

  • Zero or more content assets involved in the action. Currently these include Dropbox files and folders but in the future we might add other asset types such as Paper documents, folders, projects, etc.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSArray<DBTEAMLOGAssetLogInfo *> *assets;

    Swift

    var assets: [DBTEAMLOGAssetLogInfo]? { get }

  • The particular type of action taken.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMLOGEventType *_Nonnull eventType;

    Swift

    var eventType: DBTEAMLOGEventType { get }

  • The variable event schema applicable to this type of action, instantiated with respect to this particular action.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMLOGEventDetails *_Nonnull details;

    Swift

    var details: DBTEAMLOGEventDetails { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
       initWithTimestamp:(nonnull NSDate *)timestamp
           eventCategory:(nonnull DBTEAMLOGEventCategory *)eventCategory
               eventType:(nonnull DBTEAMLOGEventType *)eventType
                 details:(nonnull DBTEAMLOGEventDetails *)details
                   actor:(nullable DBTEAMLOGActorLogInfo *)actor
                  origin:(nullable DBTEAMLOGOriginLogInfo *)origin
    involveNonTeamMember:(nullable NSNumber *)involveNonTeamMember
                 context:(nullable DBTEAMLOGContextLogInfo *)context
            participants:
                (nullable NSArray<DBTEAMLOGParticipantLogInfo *> *)participants
                  assets:(nullable NSArray<DBTEAMLOGAssetLogInfo *> *)assets;

    Swift

    init(timestamp: Date, eventCategory: DBTEAMLOGEventCategory, eventType: DBTEAMLOGEventType, details: DBTEAMLOGEventDetails, actor: DBTEAMLOGActorLogInfo?, origin: DBTEAMLOGOriginLogInfo?, involveNonTeamMember: NSNumber?, context: DBTEAMLOGContextLogInfo?, participants: [DBTEAMLOGParticipantLogInfo]?, assets: [DBTEAMLOGAssetLogInfo]?)

    Parameters

    timestamp

    The Dropbox timestamp representing when the action was taken.
    eventCategory

    The category that this type of action belongs to.
    eventType

    The particular type of action taken.
    details

    The variable event schema applicable to this type of action, instantiated with respect to this particular action.
    actor

    The entity who actually performed the action. Might be missing due to historical data gap.
    origin

    The origin from which the actor performed the action including information about host, ip address, location, session, etc. If the action was performed programmatically via the API the origin represents the API client.
    involveNonTeamMember

    True if the action involved a non team member either as the actor or as one of the affected users. Might be missing due to historical data gap.
    context

    The user or team on whose behalf the actor performed the action. Might be missing due to historical data gap.
    participants

    Zero or more users and/or groups that are affected by the action. Note that this list doesn’t include any actors or users in context.
    assets

    Zero or more content assets involved in the action. Currently these include Dropbox files and folders but in the future we might add other asset types such as Paper documents, folders, projects, etc.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithTimestamp:(nonnull NSDate *)timestamp
        eventCategory:(nonnull DBTEAMLOGEventCategory *)eventCategory
            eventType:(nonnull DBTEAMLOGEventType *)eventType
              details:(nonnull DBTEAMLOGEventDetails *)details;

    Swift

    init(timestamp: Date, eventCategory: DBTEAMLOGEventCategory, eventType: DBTEAMLOGEventType, details: DBTEAMLOGEventDetails)

    Parameters

    timestamp

    The Dropbox timestamp representing when the action was taken.
    eventCategory

    The category that this type of action belongs to.
    eventType

    The particular type of action taken.
    details

    The variable event schema applicable to this type of action, instantiated with respect to this particular action.

    Return Value

    An initialized instance.