TeamLogRoutes

open class TeamLogRoutes

Copyright © 2016 Dropbox, Inc. All rights reserved.

Auto-generated by Stone, do not modify.

Routes for the team_log namespace

  • Retrieves team events. Events have a lifespan of two years. Events older than two years will not be returned. 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

    Swift

    @discardableResult
    open func getEvents(limit: UInt32 = 1000, accountId: String? = nil, time: TeamCommon.TimeRange? = nil, category: TeamLog.EventCategory? = nil) -> RpcRequest<TeamLog.GetTeamEventsResultSerializer, TeamLog.GetTeamEventsErrorSerializer>

    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 ony 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.

    Return Value

    Through the response callback, the caller will receive a TeamLog.GetTeamEventsResult object on success or a TeamLog.GetTeamEventsError object on failure.

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

    Declaration

    Swift

    @discardableResult
    open func getEventsContinue(cursor: String) -> RpcRequest<TeamLog.GetTeamEventsResultSerializer, TeamLog.GetTeamEventsContinueErrorSerializer>

    Parameters

    cursor

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

    Return Value

    Through the response callback, the caller will receive a TeamLog.GetTeamEventsResult object on success or a TeamLog.GetTeamEventsContinueError object on failure.