Class TeamLogTeamRoutes

The routes for the Dropbox.Api.TeamLog namespace

Inheritance

System.Object

TeamLogTeamRoutes

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dropbox.Api.TeamLog.Routes

Assembly: Dropbox.Api.dll

Syntax

public class TeamLogTeamRoutes

Methods

| Improve this Doc View Source

BeginGetEvents(GetTeamEventsArg, AsyncCallback, Object)

Begins an asynchronous send to the get events route.

Declaration

public IAsyncResult BeginGetEvents(GetTeamEventsArg getTeamEventsArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTeamEventsArg	getTeamEventsArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginGetEvents(UInt32, String, TimeRange, EventCategory, EventTypeArg, AsyncCallback, Object)

Begins an asynchronous send to the get events route.

Declaration

public IAsyncResult BeginGetEvents(uint limit = 1000U, string accountId = null, TimeRange time = null, EventCategory category = null, EventTypeArg eventType = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.UInt32	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 GetEventsContinueAsync(GetTeamEventsContinueArg).
System.String	accountId	Filter the events by account ID. Return only events with this account_id as either Actor, Context, or Participants.
TimeRange	time	Filter by time range.
EventCategory	category	Filter the returned events to a single category. Note that category shouldn't be provided together with event_type.
EventTypeArg	eventType	Filter the returned events to a single event type. Note that event_type shouldn't be provided together with category.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginGetEventsContinue(GetTeamEventsContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the get events continue route.

Declaration

public IAsyncResult BeginGetEventsContinue(GetTeamEventsContinueArg getTeamEventsContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTeamEventsContinueArg	getTeamEventsContinueArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginGetEventsContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the get events continue route.

Declaration

public IAsyncResult BeginGetEventsContinue(string cursor, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	cursor	Indicates from what point to get the next set of events.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

EndGetEvents(IAsyncResult)

Waits for the pending asynchronous send to the get events route to complete

Declaration

public GetTeamEventsResult EndGetEvents(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTeamEventsResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetTeamEventsError.

| Improve this Doc View Source

EndGetEventsContinue(IAsyncResult)

Waits for the pending asynchronous send to the get events continue route to complete

Declaration

public GetTeamEventsResult EndGetEventsContinue(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTeamEventsResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetTeamEventsContinueError.

| Improve this Doc View Source

GetEventsAsync(GetTeamEventsArg)

Declaration

public Task<GetTeamEventsResult> GetEventsAsync(GetTeamEventsArg getTeamEventsArg)

Parameters

Type	Name	Description
GetTeamEventsArg	getTeamEventsArg

Returns

Type	Description
System.Threading.Tasks.Task<GetTeamEventsResult>

| Improve this Doc View Source

GetEventsAsync(UInt32, String, TimeRange, EventCategory, EventTypeArg)

Declaration

public Task<GetTeamEventsResult> GetEventsAsync(uint limit = 1000U, string accountId = null, TimeRange time = null, EventCategory category = null, EventTypeArg eventType = null)

Parameters

Type	Name	Description
System.UInt32	limit
System.String	accountId
TimeRange	time
EventCategory	category
EventTypeArg	eventType

Returns

Type	Description
System.Threading.Tasks.Task<GetTeamEventsResult>

| Improve this Doc View Source

GetEventsContinueAsync(GetTeamEventsContinueArg)

Once a cursor has been retrieved from GetEventsAsync(GetTeamEventsArg), use this to paginate through all events.

Permission : Team Auditing.

Declaration

public Task<GetTeamEventsResult> GetEventsContinueAsync(GetTeamEventsContinueArg getTeamEventsContinueArg)

Parameters

Type	Name	Description
GetTeamEventsContinueArg	getTeamEventsContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetTeamEventsResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetTeamEventsContinueError.

| Improve this Doc View Source

GetEventsContinueAsync(String)

Once a cursor has been retrieved from GetEventsAsync(GetTeamEventsArg), use this to paginate through all events.

Permission : Team Auditing.

Declaration

public Task<GetTeamEventsResult> GetEventsContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	Indicates from what point to get the next set of events.

Returns

Type	Description
System.Threading.Tasks.Task<GetTeamEventsResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetTeamEventsContinueError.