DBTEAMLOGTeamAuthRoutes

Objective-C

@interface DBTEAMLOGTeamAuthRoutes : NSObject

Swift

class DBTEAMLOGTeamAuthRoutes : NSObject

Routes for the TeamLog namespace

client
An instance of the networking client that each route will use to submit a request.
Declaration
Objective-C

@property (nonatomic, readonly) id<DBTransportClient> _Nonnull client;
-init:
Initializes the DBTEAMLOGTeamAuthRoutes namespace container object with a networking client.
Declaration
Objective-C

- (nonnull instancetype)init:(nonnull id<DBTransportClient>)client;
-getEvents
Retrieves team events. If the result’s hasMore in DBTEAMLOGGetTeamEventsResult field is true, call getEventsContinue with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll getEventsContinue for new events. Many attributes note ‘may be missing due to historical data gap’. Note that the file_operations category and & analogous paper events are not available on all Dropbox Business plans /business/plans-comparison. Use features/get_values /developers/documentation/http/teams#team-features-get_values to check for this feature. Permission : Team Auditing.
Declaration
Objective-C

- (nonnull DBRpcTask<DBTEAMLOGGetTeamEventsResult *, DBTEAMLOGGetTeamEventsError *> *)getEvents;
Swift

func getEvents() -> DBRpcTask<DBTEAMLOGGetTeamEventsResult, DBTEAMLOGGetTeamEventsError>
Return Value

Through the response callback, the caller will receive a DBTEAMLOGGetTeamEventsResult object on success or a DBTEAMLOGGetTeamEventsError object on failure.


                    
                    
                    -getEvents:accountId:time:category:eventType:

Retrieves team events. If the result’s hasMore in DBTEAMLOGGetTeamEventsResult field is true, call getEventsContinue with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll getEventsContinue for new events. Many attributes note ‘may be missing due to historical data gap’. Note that the file_operations category and & analogous paper events are not available on all Dropbox Business plans /business/plans-comparison. Use features/get_values /developers/documentation/http/teams#team-features-get_values to check for this feature. Permission : Team Auditing.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLOGGetTeamEventsResult *,
                     DBTEAMLOGGetTeamEventsError *> *)
    getEvents:(nullable NSNumber *)limit
    accountId:(nullable NSString *)accountId
         time:(nullable DBTEAMCOMMONTimeRange *)time
     category:(nullable DBTEAMLOGEventCategory *)category
    eventType:(nullable DBTEAMLOGEventTypeArg *)eventType;

Swift

func getEvents(_ limit: NSNumber?, accountId: String?, time: DBTEAMCOMMONTimeRange?, category: DBTEAMLOGEventCategory?, eventType: DBTEAMLOGEventTypeArg?) -> DBRpcTask<DBTEAMLOGGetTeamEventsResult, DBTEAMLOGGetTeamEventsError>

Parameters

`limit`	The maximal number of results to return per call. Note that some calls may not return limit number of events, and may even return no events, even with `has_more` set to true. In this case, callers should fetch again using `getEventsContinue`.
`accountId`	Filter the events by account ID. Return only events with this account_id as either Actor, Context, or Participants.
`time`	Filter by time range.
`category`	Filter the returned events to a single category. Note that category shouldn’t be provided together with event_type.
`eventType`	Filter the returned events to a single event type. Note that event_type shouldn’t be provided together with category.

Return Value

Through the response callback, the caller will receive a DBTEAMLOGGetTeamEventsResult object on success or a DBTEAMLOGGetTeamEventsError object on failure.


                    
                    
                    -getEventsContinue:

Once a cursor has been retrieved from getEvents, use this to paginate through all events. Permission : Team Auditing.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLOGGetTeamEventsResult *,
                     DBTEAMLOGGetTeamEventsContinueError *> *)getEventsContinue:
    (nonnull NSString *)cursor;

Swift

func getEventsContinue(_ cursor: String) -> DBRpcTask<DBTEAMLOGGetTeamEventsResult, DBTEAMLOGGetTeamEventsContinueError>

Parameters


                                cursor

Indicates from what point to get the next set of events.

Return Value

Through the response callback, the caller will receive a DBTEAMLOGGetTeamEventsResult object on success or a DBTEAMLOGGetTeamEventsContinueError object on failure.