Class TeamTeamRoutes
The routes for the Dropbox.Api.Team namespace
Inheritance
Inherited Members
Namespace: Dropbox.Api.Team.Routes
Assembly: Dropbox.Api.dll
Syntax
public class TeamTeamRoutes
Methods
| Improve this Doc View SourceBeginDevicesListMemberDevices(ListMemberDevicesArg, AsyncCallback, Object)
Begins an asynchronous send to the devices list member devices route.
Declaration
public IAsyncResult BeginDevicesListMemberDevices(ListMemberDevicesArg listMemberDevicesArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ListMemberDevicesArg | listMemberDevicesArg | 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. |
BeginDevicesListMemberDevices(String, Boolean, Boolean, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the devices list member devices route.
Declaration
public IAsyncResult BeginDevicesListMemberDevices(string teamMemberId, bool includeWebSessions = true, bool includeDesktopClients = true, bool includeMobileClients = true, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamMemberId | The team's member id. |
System.Boolean | includeWebSessions | Whether to list web sessions of the team's member. |
System.Boolean | includeDesktopClients | Whether to list linked desktop devices of the team's member. |
System.Boolean | includeMobileClients | Whether to list linked mobile devices of the team's member. |
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. |
BeginDevicesListMembersDevices(ListMembersDevicesArg, AsyncCallback, Object)
Begins an asynchronous send to the devices list members devices route.
Declaration
public IAsyncResult BeginDevicesListMembersDevices(ListMembersDevicesArg listMembersDevicesArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ListMembersDevicesArg | listMembersDevicesArg | 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. |
BeginDevicesListMembersDevices(String, Boolean, Boolean, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the devices list members devices route.
Declaration
public IAsyncResult BeginDevicesListMembersDevices(string cursor = null, bool includeWebSessions = true, bool includeDesktopClients = true, bool includeMobileClients = true, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | At the first call to the DevicesListMembersDevicesAsync(ListMembersDevicesArg) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices. |
System.Boolean | includeWebSessions | Whether to list web sessions of the team members. |
System.Boolean | includeDesktopClients | Whether to list desktop clients of the team members. |
System.Boolean | includeMobileClients | Whether to list mobile clients of the team members. |
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. |
BeginDevicesListTeamDevices(ListTeamDevicesArg, AsyncCallback, Object)
Begins an asynchronous send to the devices list team devices route.
Declaration
[Obsolete("This function is deprecated, please use BeginDevicesListMembersDevices instead.")]
public IAsyncResult BeginDevicesListTeamDevices(ListTeamDevicesArg listTeamDevicesArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ListTeamDevicesArg | listTeamDevicesArg | 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. |
BeginDevicesListTeamDevices(String, Boolean, Boolean, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the devices list team devices route.
Declaration
[Obsolete("This function is deprecated, please use BeginDevicesListMembersDevices instead.")]
public IAsyncResult BeginDevicesListTeamDevices(string cursor = null, bool includeWebSessions = true, bool includeDesktopClients = true, bool includeMobileClients = true, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | At the first call to the DevicesListTeamDevicesAsync(ListTeamDevicesArg) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices. |
System.Boolean | includeWebSessions | Whether to list web sessions of the team members. |
System.Boolean | includeDesktopClients | Whether to list desktop clients of the team members. |
System.Boolean | includeMobileClients | Whether to list mobile clients of the team members. |
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. |
BeginDevicesRevokeDeviceSession(RevokeDeviceSessionArg, AsyncCallback, Object)
Begins an asynchronous send to the devices revoke device session route.
Declaration
public IAsyncResult BeginDevicesRevokeDeviceSession(RevokeDeviceSessionArg revokeDeviceSessionArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
RevokeDeviceSessionArg | revokeDeviceSessionArg | 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. |
BeginDevicesRevokeDeviceSessionBatch(RevokeDeviceSessionBatchArg, AsyncCallback, Object)
Begins an asynchronous send to the devices revoke device session batch route.
Declaration
public IAsyncResult BeginDevicesRevokeDeviceSessionBatch(RevokeDeviceSessionBatchArg revokeDeviceSessionBatchArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
RevokeDeviceSessionBatchArg | revokeDeviceSessionBatchArg | 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. |
BeginDevicesRevokeDeviceSessionBatch(IEnumerable<RevokeDeviceSessionArg>, AsyncCallback, Object)
Begins an asynchronous send to the devices revoke device session batch route.
Declaration
public IAsyncResult BeginDevicesRevokeDeviceSessionBatch(IEnumerable<RevokeDeviceSessionArg> revokeDevices, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<RevokeDeviceSessionArg> | revokeDevices | The revoke devices |
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. |
BeginFeaturesGetValues(FeaturesGetValuesBatchArg, AsyncCallback, Object)
Begins an asynchronous send to the features get values route.
Declaration
public IAsyncResult BeginFeaturesGetValues(FeaturesGetValuesBatchArg featuresGetValuesBatchArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
FeaturesGetValuesBatchArg | featuresGetValuesBatchArg | 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. |
BeginFeaturesGetValues(IEnumerable<Feature>, AsyncCallback, Object)
Begins an asynchronous send to the features get values route.
Declaration
public IAsyncResult BeginFeaturesGetValues(IEnumerable<Feature> features, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<Feature> | features | A list of features in Feature. If the list is empty, this route will return FeaturesGetValuesBatchError. |
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. |
BeginGetInfo(AsyncCallback, Object)
Begins an asynchronous send to the get info route.
Declaration
public IAsyncResult BeginGetInfo(AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
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. |
BeginGroupsCreate(GroupCreateArg, AsyncCallback, Object)
Begins an asynchronous send to the groups create route.
Declaration
public IAsyncResult BeginGroupsCreate(GroupCreateArg groupCreateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupCreateArg | groupCreateArg | 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. |
BeginGroupsCreate(String, Boolean, String, GroupManagementType, AsyncCallback, Object)
Begins an asynchronous send to the groups create route.
Declaration
public IAsyncResult BeginGroupsCreate(string groupName, bool addCreatorAsOwner = false, string groupExternalId = null, GroupManagementType groupManagementType = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | groupName | Group name. |
System.Boolean | addCreatorAsOwner | Automatically add the creator of the group. |
System.String | groupExternalId | The creator of a team can associate an arbitrary external ID to the group. |
GroupManagementType | groupManagementType | Whether the team can be managed by selected users, or only by team admins. |
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. |
BeginGroupsDelete(GroupSelector, AsyncCallback, Object)
Begins an asynchronous send to the groups delete route.
Declaration
public IAsyncResult BeginGroupsDelete(GroupSelector groupSelector, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | groupSelector | 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. |
BeginGroupsGetInfo(GroupsSelector, AsyncCallback, Object)
Begins an asynchronous send to the groups get info route.
Declaration
public IAsyncResult BeginGroupsGetInfo(GroupsSelector groupsSelector, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupsSelector | groupsSelector | 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. |
BeginGroupsJobStatusGet(PollArg, AsyncCallback, Object)
Begins an asynchronous send to the groups job status get route.
Declaration
public IAsyncResult BeginGroupsJobStatusGet(PollArg pollArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | 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. |
BeginGroupsJobStatusGet(String, AsyncCallback, Object)
Begins an asynchronous send to the groups job status get route.
Declaration
public IAsyncResult BeginGroupsJobStatusGet(string asyncJobId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
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. |
BeginGroupsList(GroupsListArg, AsyncCallback, Object)
Begins an asynchronous send to the groups list route.
Declaration
public IAsyncResult BeginGroupsList(GroupsListArg groupsListArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupsListArg | groupsListArg | 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. |
BeginGroupsList(UInt32, AsyncCallback, Object)
Begins an asynchronous send to the groups list route.
Declaration
public IAsyncResult BeginGroupsList(uint limit = 1000U, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Number of results to return per call. |
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. |
BeginGroupsListContinue(GroupsListContinueArg, AsyncCallback, Object)
Begins an asynchronous send to the groups list continue route.
Declaration
public IAsyncResult BeginGroupsListContinue(GroupsListContinueArg groupsListContinueArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupsListContinueArg | groupsListContinueArg | 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. |
BeginGroupsListContinue(String, AsyncCallback, Object)
Begins an asynchronous send to the groups list continue route.
Declaration
public IAsyncResult BeginGroupsListContinue(string cursor, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of groups. |
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. |
BeginGroupsMembersAdd(GroupMembersAddArg, AsyncCallback, Object)
Begins an asynchronous send to the groups members add route.
Declaration
public IAsyncResult BeginGroupsMembersAdd(GroupMembersAddArg groupMembersAddArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupMembersAddArg | groupMembersAddArg | 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. |
BeginGroupsMembersAdd(GroupSelector, IEnumerable<MemberAccess>, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the groups members add route.
Declaration
public IAsyncResult BeginGroupsMembersAdd(GroupSelector group, IEnumerable<MemberAccess> members, bool returnMembers = true, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | Group to which users will be added. |
System.Collections.Generic.IEnumerable<MemberAccess> | members | List of users to be added to the group. |
System.Boolean | returnMembers | Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. |
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. |
BeginGroupsMembersList(GroupSelector, UInt32, AsyncCallback, Object)
Begins an asynchronous send to the groups members list route.
Declaration
public IAsyncResult BeginGroupsMembersList(GroupSelector group, uint limit = 1000U, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | The group whose members are to be listed. |
System.UInt32 | limit | Number of results to return per call. |
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. |
BeginGroupsMembersList(GroupsMembersListArg, AsyncCallback, Object)
Begins an asynchronous send to the groups members list route.
Declaration
public IAsyncResult BeginGroupsMembersList(GroupsMembersListArg groupsMembersListArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupsMembersListArg | groupsMembersListArg | 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. |
BeginGroupsMembersListContinue(GroupsMembersListContinueArg, AsyncCallback, Object)
Begins an asynchronous send to the groups members list continue route.
Declaration
public IAsyncResult BeginGroupsMembersListContinue(GroupsMembersListContinueArg groupsMembersListContinueArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupsMembersListContinueArg | groupsMembersListContinueArg | 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. |
BeginGroupsMembersListContinue(String, AsyncCallback, Object)
Begins an asynchronous send to the groups members list continue route.
Declaration
public IAsyncResult BeginGroupsMembersListContinue(string cursor, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of groups. |
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. |
BeginGroupsMembersRemove(GroupMembersRemoveArg, AsyncCallback, Object)
Begins an asynchronous send to the groups members remove route.
Declaration
public IAsyncResult BeginGroupsMembersRemove(GroupMembersRemoveArg groupMembersRemoveArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupMembersRemoveArg | groupMembersRemoveArg | 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. |
BeginGroupsMembersRemove(GroupSelector, IEnumerable<UserSelectorArg>, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the groups members remove route.
Declaration
public IAsyncResult BeginGroupsMembersRemove(GroupSelector group, IEnumerable<UserSelectorArg> users, bool returnMembers = true, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | Group from which users will be removed. |
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users to be removed from the group. |
System.Boolean | returnMembers | Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. |
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. |
BeginGroupsMembersSetAccessType(GroupMembersSetAccessTypeArg, AsyncCallback, Object)
Begins an asynchronous send to the groups members set access type route.
Declaration
public IAsyncResult BeginGroupsMembersSetAccessType(GroupMembersSetAccessTypeArg groupMembersSetAccessTypeArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupMembersSetAccessTypeArg | groupMembersSetAccessTypeArg | 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. |
BeginGroupsMembersSetAccessType(GroupSelector, UserSelectorArg, GroupAccessType, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the groups members set access type route.
Declaration
public IAsyncResult BeginGroupsMembersSetAccessType(GroupSelector group, UserSelectorArg user, GroupAccessType accessType, bool returnMembers = true, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | Specify a group. |
UserSelectorArg | user | Identity of a user that is a member of |
GroupAccessType | accessType | New group access type the user will have. |
System.Boolean | returnMembers | Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. |
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. |
BeginGroupsUpdate(GroupSelector, Boolean, String, String, GroupManagementType, AsyncCallback, Object)
Begins an asynchronous send to the groups update route.
Declaration
public IAsyncResult BeginGroupsUpdate(GroupSelector group, bool returnMembers = true, string newGroupName = null, string newGroupExternalId = null, GroupManagementType newGroupManagementType = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | Specify a group. |
System.Boolean | returnMembers | Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. |
System.String | newGroupName | Optional argument. Set group name to this if provided. |
System.String | newGroupExternalId | Optional argument. New group external ID. If the argument is None, the group's external_id won't be updated. If the argument is empty string, the group's external id will be cleared. |
GroupManagementType | newGroupManagementType | Set new group management type, if provided. |
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. |
BeginGroupsUpdate(GroupUpdateArgs, AsyncCallback, Object)
Begins an asynchronous send to the groups update route.
Declaration
public IAsyncResult BeginGroupsUpdate(GroupUpdateArgs groupUpdateArgs, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GroupUpdateArgs | groupUpdateArgs | 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. |
BeginLegalHoldsCreatePolicy(LegalHoldsPolicyCreateArg, AsyncCallback, Object)
Begins an asynchronous send to the legal holds create policy route.
Declaration
public IAsyncResult BeginLegalHoldsCreatePolicy(LegalHoldsPolicyCreateArg legalHoldsPolicyCreateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsPolicyCreateArg | legalHoldsPolicyCreateArg | 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. |
BeginLegalHoldsCreatePolicy(String, IEnumerable<String>, String, Nullable<DateTime>, Nullable<DateTime>, AsyncCallback, Object)
Begins an asynchronous send to the legal holds create policy route.
Declaration
public IAsyncResult BeginLegalHoldsCreatePolicy(string name, IEnumerable<string> members, string description = null, DateTime? startDate = null, DateTime? endDate = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Policy name. |
System.Collections.Generic.IEnumerable<System.String> | members | List of team member IDs added to the hold. |
System.String | description | A description of the legal hold policy. |
System.Nullable<System.DateTime> | startDate | start date of the legal hold policy. |
System.Nullable<System.DateTime> | endDate | end date of the legal hold policy. |
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. |
BeginLegalHoldsGetPolicy(LegalHoldsGetPolicyArg, AsyncCallback, Object)
Begins an asynchronous send to the legal holds get policy route.
Declaration
public IAsyncResult BeginLegalHoldsGetPolicy(LegalHoldsGetPolicyArg legalHoldsGetPolicyArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsGetPolicyArg | legalHoldsGetPolicyArg | 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. |
BeginLegalHoldsGetPolicy(String, AsyncCallback, Object)
Begins an asynchronous send to the legal holds get policy route.
Declaration
public IAsyncResult BeginLegalHoldsGetPolicy(string id, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
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. |
BeginLegalHoldsListHeldRevisions(LegalHoldsListHeldRevisionsArg, AsyncCallback, Object)
Begins an asynchronous send to the legal holds list held revisions route.
Declaration
public IAsyncResult BeginLegalHoldsListHeldRevisions(LegalHoldsListHeldRevisionsArg legalHoldsListHeldRevisionsArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsListHeldRevisionsArg | legalHoldsListHeldRevisionsArg | 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. |
BeginLegalHoldsListHeldRevisions(String, AsyncCallback, Object)
Begins an asynchronous send to the legal holds list held revisions route.
Declaration
public IAsyncResult BeginLegalHoldsListHeldRevisions(string id, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
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. |
BeginLegalHoldsListHeldRevisionsContinue(LegalHoldsListHeldRevisionsContinueArg, AsyncCallback, Object)
Begins an asynchronous send to the legal holds list held revisions continue route.
Declaration
public IAsyncResult BeginLegalHoldsListHeldRevisionsContinue(LegalHoldsListHeldRevisionsContinueArg legalHoldsListHeldRevisionsContinueArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsListHeldRevisionsContinueArg | legalHoldsListHeldRevisionsContinueArg | 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. |
BeginLegalHoldsListHeldRevisionsContinue(String, String, AsyncCallback, Object)
Begins an asynchronous send to the legal holds list held revisions continue route.
Declaration
public IAsyncResult BeginLegalHoldsListHeldRevisionsContinue(string id, string cursor = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
System.String | cursor | The cursor idicates where to continue reading file metadata entries for the next API call. When there are no more entries, the cursor will return none. |
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. |
BeginLegalHoldsListPolicies(LegalHoldsListPoliciesArg, AsyncCallback, Object)
Begins an asynchronous send to the legal holds list policies route.
Declaration
public IAsyncResult BeginLegalHoldsListPolicies(LegalHoldsListPoliciesArg legalHoldsListPoliciesArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsListPoliciesArg | legalHoldsListPoliciesArg | 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. |
BeginLegalHoldsListPolicies(Boolean, AsyncCallback, Object)
Begins an asynchronous send to the legal holds list policies route.
Declaration
public IAsyncResult BeginLegalHoldsListPolicies(bool includeReleased = false, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | includeReleased | Whether to return holds that were released. |
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. |
BeginLegalHoldsReleasePolicy(LegalHoldsPolicyReleaseArg, AsyncCallback, Object)
Begins an asynchronous send to the legal holds release policy route.
Declaration
public IAsyncResult BeginLegalHoldsReleasePolicy(LegalHoldsPolicyReleaseArg legalHoldsPolicyReleaseArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsPolicyReleaseArg | legalHoldsPolicyReleaseArg | 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. |
BeginLegalHoldsReleasePolicy(String, AsyncCallback, Object)
Begins an asynchronous send to the legal holds release policy route.
Declaration
public IAsyncResult BeginLegalHoldsReleasePolicy(string id, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
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. |
BeginLegalHoldsUpdatePolicy(LegalHoldsPolicyUpdateArg, AsyncCallback, Object)
Begins an asynchronous send to the legal holds update policy route.
Declaration
public IAsyncResult BeginLegalHoldsUpdatePolicy(LegalHoldsPolicyUpdateArg legalHoldsPolicyUpdateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsPolicyUpdateArg | legalHoldsPolicyUpdateArg | 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. |
BeginLegalHoldsUpdatePolicy(String, String, String, IEnumerable<String>, AsyncCallback, Object)
Begins an asynchronous send to the legal holds update policy route.
Declaration
public IAsyncResult BeginLegalHoldsUpdatePolicy(string id, string name = null, string description = null, IEnumerable<string> members = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
System.String | name | Policy new name. |
System.String | description | Policy new description. |
System.Collections.Generic.IEnumerable<System.String> | members | List of team member IDs to apply the policy on. |
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. |
BeginLinkedAppsListMemberLinkedApps(ListMemberAppsArg, AsyncCallback, Object)
Begins an asynchronous send to the linked apps list member linked apps route.
Declaration
public IAsyncResult BeginLinkedAppsListMemberLinkedApps(ListMemberAppsArg listMemberAppsArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ListMemberAppsArg | listMemberAppsArg | 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. |
BeginLinkedAppsListMemberLinkedApps(String, AsyncCallback, Object)
Begins an asynchronous send to the linked apps list member linked apps route.
Declaration
public IAsyncResult BeginLinkedAppsListMemberLinkedApps(string teamMemberId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamMemberId | The team member id. |
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. |
BeginLinkedAppsListMembersLinkedApps(ListMembersAppsArg, AsyncCallback, Object)
Begins an asynchronous send to the linked apps list members linked apps route.
Declaration
public IAsyncResult BeginLinkedAppsListMembersLinkedApps(ListMembersAppsArg listMembersAppsArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ListMembersAppsArg | listMembersAppsArg | 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. |
BeginLinkedAppsListMembersLinkedApps(String, AsyncCallback, Object)
Begins an asynchronous send to the linked apps list members linked apps route.
Declaration
public IAsyncResult BeginLinkedAppsListMembersLinkedApps(string cursor = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | At the first call to the LinkedAppsListMembersLinkedAppsAsync(ListMembersAppsArg) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications. |
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. |
BeginLinkedAppsListTeamLinkedApps(ListTeamAppsArg, AsyncCallback, Object)
Begins an asynchronous send to the linked apps list team linked apps route.
Declaration
[Obsolete("This function is deprecated, please use BeginLinkedAppsListMembersLinkedApps instead.")]
public IAsyncResult BeginLinkedAppsListTeamLinkedApps(ListTeamAppsArg listTeamAppsArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ListTeamAppsArg | listTeamAppsArg | 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. |
BeginLinkedAppsListTeamLinkedApps(String, AsyncCallback, Object)
Begins an asynchronous send to the linked apps list team linked apps route.
Declaration
[Obsolete("This function is deprecated, please use BeginLinkedAppsListMembersLinkedApps instead.")]
public IAsyncResult BeginLinkedAppsListTeamLinkedApps(string cursor = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | At the first call to the LinkedAppsListTeamLinkedAppsAsync(ListTeamAppsArg) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications. |
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. |
BeginLinkedAppsRevokeLinkedApp(RevokeLinkedApiAppArg, AsyncCallback, Object)
Begins an asynchronous send to the linked apps revoke linked app route.
Declaration
public IAsyncResult BeginLinkedAppsRevokeLinkedApp(RevokeLinkedApiAppArg revokeLinkedApiAppArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
RevokeLinkedApiAppArg | revokeLinkedApiAppArg | 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. |
BeginLinkedAppsRevokeLinkedApp(String, String, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the linked apps revoke linked app route.
Declaration
public IAsyncResult BeginLinkedAppsRevokeLinkedApp(string appId, string teamMemberId, bool keepAppFolder = true, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | appId | The application's unique id. |
System.String | teamMemberId | The unique id of the member owning the device. |
System.Boolean | keepAppFolder | This flag is not longer supported, the application dedicated folder (in case the application uses one) will be kept. |
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. |
BeginLinkedAppsRevokeLinkedAppBatch(RevokeLinkedApiAppBatchArg, AsyncCallback, Object)
Begins an asynchronous send to the linked apps revoke linked app batch route.
Declaration
public IAsyncResult BeginLinkedAppsRevokeLinkedAppBatch(RevokeLinkedApiAppBatchArg revokeLinkedApiAppBatchArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
RevokeLinkedApiAppBatchArg | revokeLinkedApiAppBatchArg | 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. |
BeginLinkedAppsRevokeLinkedAppBatch(IEnumerable<RevokeLinkedApiAppArg>, AsyncCallback, Object)
Begins an asynchronous send to the linked apps revoke linked app batch route.
Declaration
public IAsyncResult BeginLinkedAppsRevokeLinkedAppBatch(IEnumerable<RevokeLinkedApiAppArg> revokeLinkedApp, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<RevokeLinkedApiAppArg> | revokeLinkedApp | The revoke linked app |
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. |
BeginMembersAdd(MembersAddArg, AsyncCallback, Object)
Begins an asynchronous send to the members add route.
Declaration
public IAsyncResult BeginMembersAdd(MembersAddArg membersAddArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersAddArg | membersAddArg | 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. |
BeginMembersAdd(IEnumerable<MemberAddArg>, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the members add route.
Declaration
public IAsyncResult BeginMembersAdd(IEnumerable<MemberAddArg> newMembers, bool forceAsync = false, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<MemberAddArg> | newMembers | Details of new members to be added to the team. |
System.Boolean | forceAsync | Whether to force the add to happen asynchronously. |
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. |
BeginMembersAddJobStatusGet(PollArg, AsyncCallback, Object)
Begins an asynchronous send to the members add job status get route.
Declaration
public IAsyncResult BeginMembersAddJobStatusGet(PollArg pollArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | 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. |
BeginMembersAddJobStatusGet(String, AsyncCallback, Object)
Begins an asynchronous send to the members add job status get route.
Declaration
public IAsyncResult BeginMembersAddJobStatusGet(string asyncJobId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
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. |
BeginMembersAddJobStatusGetV2(PollArg, AsyncCallback, Object)
Begins an asynchronous send to the members add job status get route.
Declaration
public IAsyncResult BeginMembersAddJobStatusGetV2(PollArg pollArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | 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. |
BeginMembersAddJobStatusGetV2(String, AsyncCallback, Object)
Begins an asynchronous send to the members add job status get route.
Declaration
public IAsyncResult BeginMembersAddJobStatusGetV2(string asyncJobId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
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. |
BeginMembersAddV2(MembersAddV2Arg, AsyncCallback, Object)
Begins an asynchronous send to the members add route.
Declaration
public IAsyncResult BeginMembersAddV2(MembersAddV2Arg membersAddV2Arg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersAddV2Arg | membersAddV2Arg | 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. |
BeginMembersAddV2(IEnumerable<MemberAddV2Arg>, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the members add route.
Declaration
public IAsyncResult BeginMembersAddV2(IEnumerable<MemberAddV2Arg> newMembers, bool forceAsync = false, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<MemberAddV2Arg> | newMembers | Details of new members to be added to the team. |
System.Boolean | forceAsync | Whether to force the add to happen asynchronously. |
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. |
BeginMembersDeleteProfilePhoto(MembersDeleteProfilePhotoArg, AsyncCallback, Object)
Begins an asynchronous send to the members delete profile photo route.
Declaration
public IAsyncResult BeginMembersDeleteProfilePhoto(MembersDeleteProfilePhotoArg membersDeleteProfilePhotoArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersDeleteProfilePhotoArg | membersDeleteProfilePhotoArg | 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. |
BeginMembersDeleteProfilePhoto(UserSelectorArg, AsyncCallback, Object)
Begins an asynchronous send to the members delete profile photo route.
Declaration
public IAsyncResult BeginMembersDeleteProfilePhoto(UserSelectorArg user, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of the user whose profile photo will be deleted. |
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. |
BeginMembersDeleteProfilePhotoV2(MembersDeleteProfilePhotoArg, AsyncCallback, Object)
Begins an asynchronous send to the members delete profile photo route.
Declaration
public IAsyncResult BeginMembersDeleteProfilePhotoV2(MembersDeleteProfilePhotoArg membersDeleteProfilePhotoArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersDeleteProfilePhotoArg | membersDeleteProfilePhotoArg | 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. |
BeginMembersDeleteProfilePhotoV2(UserSelectorArg, AsyncCallback, Object)
Begins an asynchronous send to the members delete profile photo route.
Declaration
public IAsyncResult BeginMembersDeleteProfilePhotoV2(UserSelectorArg user, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of the user whose profile photo will be deleted. |
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. |
BeginMembersGetAvailableTeamMemberRoles(AsyncCallback, Object)
Begins an asynchronous send to the members get available team member roles route.
Declaration
public IAsyncResult BeginMembersGetAvailableTeamMemberRoles(AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
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. |
BeginMembersGetInfo(MembersGetInfoArgs, AsyncCallback, Object)
Begins an asynchronous send to the members get info route.
Declaration
public IAsyncResult BeginMembersGetInfo(MembersGetInfoArgs membersGetInfoArgs, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersGetInfoArgs | membersGetInfoArgs | 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. |
BeginMembersGetInfo(IEnumerable<UserSelectorArg>, AsyncCallback, Object)
Begins an asynchronous send to the members get info route.
Declaration
public IAsyncResult BeginMembersGetInfo(IEnumerable<UserSelectorArg> members, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | members | List of team members. |
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. |
BeginMembersGetInfoV2(MembersGetInfoV2Arg, AsyncCallback, Object)
Begins an asynchronous send to the members get info route.
Declaration
public IAsyncResult BeginMembersGetInfoV2(MembersGetInfoV2Arg membersGetInfoV2Arg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersGetInfoV2Arg | membersGetInfoV2Arg | 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. |
BeginMembersGetInfoV2(IEnumerable<UserSelectorArg>, AsyncCallback, Object)
Begins an asynchronous send to the members get info route.
Declaration
public IAsyncResult BeginMembersGetInfoV2(IEnumerable<UserSelectorArg> members, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | members | List of team members. |
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. |
BeginMembersList(MembersListArg, AsyncCallback, Object)
Begins an asynchronous send to the members list route.
Declaration
public IAsyncResult BeginMembersList(MembersListArg membersListArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersListArg | membersListArg | 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. |
BeginMembersList(UInt32, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the members list route.
Declaration
public IAsyncResult BeginMembersList(uint limit = 1000U, bool includeRemoved = false, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Number of results to return per call. |
System.Boolean | includeRemoved | Whether to return removed members. |
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. |
BeginMembersListContinue(MembersListContinueArg, AsyncCallback, Object)
Begins an asynchronous send to the members list continue route.
Declaration
public IAsyncResult BeginMembersListContinue(MembersListContinueArg membersListContinueArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersListContinueArg | membersListContinueArg | 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. |
BeginMembersListContinue(String, AsyncCallback, Object)
Begins an asynchronous send to the members list continue route.
Declaration
public IAsyncResult BeginMembersListContinue(string cursor, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of members. |
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. |
BeginMembersListContinueV2(MembersListContinueArg, AsyncCallback, Object)
Begins an asynchronous send to the members list continue route.
Declaration
public IAsyncResult BeginMembersListContinueV2(MembersListContinueArg membersListContinueArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersListContinueArg | membersListContinueArg | 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. |
BeginMembersListContinueV2(String, AsyncCallback, Object)
Begins an asynchronous send to the members list continue route.
Declaration
public IAsyncResult BeginMembersListContinueV2(string cursor, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of members. |
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. |
BeginMembersListV2(MembersListArg, AsyncCallback, Object)
Begins an asynchronous send to the members list route.
Declaration
public IAsyncResult BeginMembersListV2(MembersListArg membersListArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersListArg | membersListArg | 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. |
BeginMembersListV2(UInt32, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the members list route.
Declaration
public IAsyncResult BeginMembersListV2(uint limit = 1000U, bool includeRemoved = false, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Number of results to return per call. |
System.Boolean | includeRemoved | Whether to return removed members. |
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. |
BeginMembersMoveFormerMemberFiles(MembersDataTransferArg, AsyncCallback, Object)
Begins an asynchronous send to the members move former member files route.
Declaration
public IAsyncResult BeginMembersMoveFormerMemberFiles(MembersDataTransferArg membersDataTransferArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersDataTransferArg | membersDataTransferArg | 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. |
BeginMembersMoveFormerMemberFiles(UserSelectorArg, UserSelectorArg, UserSelectorArg, AsyncCallback, Object)
Begins an asynchronous send to the members move former member files route.
Declaration
public IAsyncResult BeginMembersMoveFormerMemberFiles(UserSelectorArg user, UserSelectorArg transferDestId, UserSelectorArg transferAdminId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to remove/suspend/have their files moved. |
UserSelectorArg | transferDestId | Files from the deleted member account will be transferred to this user. |
UserSelectorArg | transferAdminId | Errors during the transfer process will be sent via email to this user. |
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. |
BeginMembersMoveFormerMemberFilesJobStatusCheck(PollArg, AsyncCallback, Object)
Begins an asynchronous send to the members move former member files job status check route.
Declaration
public IAsyncResult BeginMembersMoveFormerMemberFilesJobStatusCheck(PollArg pollArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | 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. |
BeginMembersMoveFormerMemberFilesJobStatusCheck(String, AsyncCallback, Object)
Begins an asynchronous send to the members move former member files job status check route.
Declaration
public IAsyncResult BeginMembersMoveFormerMemberFilesJobStatusCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
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. |
BeginMemberSpaceLimitsExcludedUsersAdd(ExcludedUsersUpdateArg, AsyncCallback, Object)
Begins an asynchronous send to the member space limits excluded users add route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsExcludedUsersAdd(ExcludedUsersUpdateArg excludedUsersUpdateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ExcludedUsersUpdateArg | excludedUsersUpdateArg | 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. |
BeginMemberSpaceLimitsExcludedUsersAdd(IEnumerable<UserSelectorArg>, AsyncCallback, Object)
Begins an asynchronous send to the member space limits excluded users add route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsExcludedUsersAdd(IEnumerable<UserSelectorArg> users = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users to be added/removed. |
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. |
BeginMemberSpaceLimitsExcludedUsersList(ExcludedUsersListArg, AsyncCallback, Object)
Begins an asynchronous send to the member space limits excluded users list route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsExcludedUsersList(ExcludedUsersListArg excludedUsersListArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ExcludedUsersListArg | excludedUsersListArg | 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. |
BeginMemberSpaceLimitsExcludedUsersList(UInt32, AsyncCallback, Object)
Begins an asynchronous send to the member space limits excluded users list route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsExcludedUsersList(uint limit = 1000U, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Number of results to return per call. |
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. |
BeginMemberSpaceLimitsExcludedUsersListContinue(ExcludedUsersListContinueArg, AsyncCallback, Object)
Begins an asynchronous send to the member space limits excluded users list continue route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsExcludedUsersListContinue(ExcludedUsersListContinueArg excludedUsersListContinueArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ExcludedUsersListContinueArg | excludedUsersListContinueArg | 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. |
BeginMemberSpaceLimitsExcludedUsersListContinue(String, AsyncCallback, Object)
Begins an asynchronous send to the member space limits excluded users list continue route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsExcludedUsersListContinue(string cursor, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of users. |
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. |
BeginMemberSpaceLimitsExcludedUsersRemove(ExcludedUsersUpdateArg, AsyncCallback, Object)
Begins an asynchronous send to the member space limits excluded users remove route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsExcludedUsersRemove(ExcludedUsersUpdateArg excludedUsersUpdateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ExcludedUsersUpdateArg | excludedUsersUpdateArg | 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. |
BeginMemberSpaceLimitsExcludedUsersRemove(IEnumerable<UserSelectorArg>, AsyncCallback, Object)
Begins an asynchronous send to the member space limits excluded users remove route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsExcludedUsersRemove(IEnumerable<UserSelectorArg> users = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users to be added/removed. |
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. |
BeginMemberSpaceLimitsGetCustomQuota(CustomQuotaUsersArg, AsyncCallback, Object)
Begins an asynchronous send to the member space limits get custom quota route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsGetCustomQuota(CustomQuotaUsersArg customQuotaUsersArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
CustomQuotaUsersArg | customQuotaUsersArg | 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. |
BeginMemberSpaceLimitsGetCustomQuota(IEnumerable<UserSelectorArg>, AsyncCallback, Object)
Begins an asynchronous send to the member space limits get custom quota route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsGetCustomQuota(IEnumerable<UserSelectorArg> users, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users. |
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. |
BeginMemberSpaceLimitsRemoveCustomQuota(CustomQuotaUsersArg, AsyncCallback, Object)
Begins an asynchronous send to the member space limits remove custom quota route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsRemoveCustomQuota(CustomQuotaUsersArg customQuotaUsersArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
CustomQuotaUsersArg | customQuotaUsersArg | 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. |
BeginMemberSpaceLimitsRemoveCustomQuota(IEnumerable<UserSelectorArg>, AsyncCallback, Object)
Begins an asynchronous send to the member space limits remove custom quota route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsRemoveCustomQuota(IEnumerable<UserSelectorArg> users, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users. |
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. |
BeginMemberSpaceLimitsSetCustomQuota(SetCustomQuotaArg, AsyncCallback, Object)
Begins an asynchronous send to the member space limits set custom quota route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsSetCustomQuota(SetCustomQuotaArg setCustomQuotaArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
SetCustomQuotaArg | setCustomQuotaArg | 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. |
BeginMemberSpaceLimitsSetCustomQuota(IEnumerable<UserCustomQuotaArg>, AsyncCallback, Object)
Begins an asynchronous send to the member space limits set custom quota route.
Declaration
public IAsyncResult BeginMemberSpaceLimitsSetCustomQuota(IEnumerable<UserCustomQuotaArg> usersAndQuotas, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserCustomQuotaArg> | usersAndQuotas | List of users and their custom quotas. |
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. |
BeginMembersRecover(MembersRecoverArg, AsyncCallback, Object)
Begins an asynchronous send to the members recover route.
Declaration
public IAsyncResult BeginMembersRecover(MembersRecoverArg membersRecoverArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersRecoverArg | membersRecoverArg | 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. |
BeginMembersRecover(UserSelectorArg, AsyncCallback, Object)
Begins an asynchronous send to the members recover route.
Declaration
public IAsyncResult BeginMembersRecover(UserSelectorArg user, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to recover. |
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. |
BeginMembersRemove(MembersRemoveArg, AsyncCallback, Object)
Begins an asynchronous send to the members remove route.
Declaration
public IAsyncResult BeginMembersRemove(MembersRemoveArg membersRemoveArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersRemoveArg | membersRemoveArg | 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. |
BeginMembersRemove(UserSelectorArg, Boolean, UserSelectorArg, UserSelectorArg, Boolean, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the members remove route.
Declaration
public IAsyncResult BeginMembersRemove(UserSelectorArg user, bool wipeData = true, UserSelectorArg transferDestId = null, UserSelectorArg transferAdminId = null, bool keepAccount = false, bool retainTeamShares = false, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to remove/suspend/have their files moved. |
System.Boolean | wipeData | If provided, controls if the user's data will be deleted on their linked devices. |
UserSelectorArg | transferDestId | If provided, files from the deleted member account will be transferred to this user. |
UserSelectorArg | transferAdminId | If provided, errors during the transfer process will be sent via email to this user. If the transfer_dest_id argument was provided, then this argument must be provided as well. |
System.Boolean | keepAccount | Downgrade the member to a Basic account. The user will
retain the email address associated with their Dropbox account and data in their
account that is not restricted to team members. In order to keep the account the
argument |
System.Boolean | retainTeamShares | If provided, allows removed users to keep access to
Dropbox folders (not Dropbox Paper folders) already explicitly shared with them
(not via a group) when they are downgraded to a Basic account. Users will not
retain access to folders that do not allow external sharing. In order to keep the
sharing relationships, the arguments |
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. |
BeginMembersRemoveJobStatusGet(PollArg, AsyncCallback, Object)
Begins an asynchronous send to the members remove job status get route.
Declaration
public IAsyncResult BeginMembersRemoveJobStatusGet(PollArg pollArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | 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. |
BeginMembersRemoveJobStatusGet(String, AsyncCallback, Object)
Begins an asynchronous send to the members remove job status get route.
Declaration
public IAsyncResult BeginMembersRemoveJobStatusGet(string asyncJobId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
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. |
BeginMembersSecondaryEmailsAdd(AddSecondaryEmailsArg, AsyncCallback, Object)
Begins an asynchronous send to the members secondary emails add route.
Declaration
public IAsyncResult BeginMembersSecondaryEmailsAdd(AddSecondaryEmailsArg addSecondaryEmailsArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
AddSecondaryEmailsArg | addSecondaryEmailsArg | 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. |
BeginMembersSecondaryEmailsAdd(IEnumerable<UserSecondaryEmailsArg>, AsyncCallback, Object)
Begins an asynchronous send to the members secondary emails add route.
Declaration
public IAsyncResult BeginMembersSecondaryEmailsAdd(IEnumerable<UserSecondaryEmailsArg> newSecondaryEmails, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSecondaryEmailsArg> | newSecondaryEmails | List of users and secondary emails to add. |
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. |
BeginMembersSecondaryEmailsDelete(DeleteSecondaryEmailsArg, AsyncCallback, Object)
Begins an asynchronous send to the members secondary emails delete route.
Declaration
public IAsyncResult BeginMembersSecondaryEmailsDelete(DeleteSecondaryEmailsArg deleteSecondaryEmailsArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
DeleteSecondaryEmailsArg | deleteSecondaryEmailsArg | 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. |
BeginMembersSecondaryEmailsDelete(IEnumerable<UserSecondaryEmailsArg>, AsyncCallback, Object)
Begins an asynchronous send to the members secondary emails delete route.
Declaration
public IAsyncResult BeginMembersSecondaryEmailsDelete(IEnumerable<UserSecondaryEmailsArg> emailsToDelete, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSecondaryEmailsArg> | emailsToDelete | List of users and their secondary emails to delete. |
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. |
BeginMembersSecondaryEmailsResendVerificationEmails(ResendVerificationEmailArg, AsyncCallback, Object)
Begins an asynchronous send to the members secondary emails resend verification emails route.
Declaration
public IAsyncResult BeginMembersSecondaryEmailsResendVerificationEmails(ResendVerificationEmailArg resendVerificationEmailArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
ResendVerificationEmailArg | resendVerificationEmailArg | 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. |
BeginMembersSecondaryEmailsResendVerificationEmails(IEnumerable<UserSecondaryEmailsArg>, AsyncCallback, Object)
Begins an asynchronous send to the members secondary emails resend verification emails route.
Declaration
public IAsyncResult BeginMembersSecondaryEmailsResendVerificationEmails(IEnumerable<UserSecondaryEmailsArg> emailsToResend, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSecondaryEmailsArg> | emailsToResend | List of users and secondary emails to resend verification emails to. |
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. |
BeginMembersSendWelcomeEmail(UserSelectorArg, AsyncCallback, Object)
Begins an asynchronous send to the members send welcome email route.
Declaration
public IAsyncResult BeginMembersSendWelcomeEmail(UserSelectorArg userSelectorArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | userSelectorArg | 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. |
BeginMembersSetAdminPermissions(MembersSetPermissionsArg, AsyncCallback, Object)
Begins an asynchronous send to the members set admin permissions route.
Declaration
public IAsyncResult BeginMembersSetAdminPermissions(MembersSetPermissionsArg membersSetPermissionsArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersSetPermissionsArg | membersSetPermissionsArg | 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. |
BeginMembersSetAdminPermissions(UserSelectorArg, AdminTier, AsyncCallback, Object)
Begins an asynchronous send to the members set admin permissions route.
Declaration
public IAsyncResult BeginMembersSetAdminPermissions(UserSelectorArg user, AdminTier newRole, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user whose role will be set. |
AdminTier | newRole | The new role of the member. |
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. |
BeginMembersSetAdminPermissionsV2(MembersSetPermissions2Arg, AsyncCallback, Object)
Begins an asynchronous send to the members set admin permissions route.
Declaration
public IAsyncResult BeginMembersSetAdminPermissionsV2(MembersSetPermissions2Arg membersSetPermissions2Arg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersSetPermissions2Arg | membersSetPermissions2Arg | 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. |
BeginMembersSetAdminPermissionsV2(UserSelectorArg, IEnumerable<String>, AsyncCallback, Object)
Begins an asynchronous send to the members set admin permissions route.
Declaration
public IAsyncResult BeginMembersSetAdminPermissionsV2(UserSelectorArg user, IEnumerable<string> newRoles = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user whose role will be set. |
System.Collections.Generic.IEnumerable<System.String> | newRoles | The new roles for the member. Send empty list to make user member only. For now, only up to one role is allowed. |
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. |
BeginMembersSetProfile(MembersSetProfileArg, AsyncCallback, Object)
Begins an asynchronous send to the members set profile route.
Declaration
public IAsyncResult BeginMembersSetProfile(MembersSetProfileArg membersSetProfileArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersSetProfileArg | membersSetProfileArg | 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. |
BeginMembersSetProfile(UserSelectorArg, String, String, String, String, String, Nullable<Boolean>, AsyncCallback, Object)
Begins an asynchronous send to the members set profile route.
Declaration
public IAsyncResult BeginMembersSetProfile(UserSelectorArg user, string newEmail = null, string newExternalId = null, string newGivenName = null, string newSurname = null, string newPersistentId = null, bool? newIsDirectoryRestricted = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user whose profile will be set. |
System.String | newEmail | New email for member. |
System.String | newExternalId | New external ID for member. |
System.String | newGivenName | New given name for member. |
System.String | newSurname | New surname for member. |
System.String | newPersistentId | New persistent ID. This field only available to teams using persistent ID SAML configuration. |
System.Nullable<System.Boolean> | newIsDirectoryRestricted | New value for whether the user is a directory restricted user. |
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. |
BeginMembersSetProfilePhoto(MembersSetProfilePhotoArg, AsyncCallback, Object)
Begins an asynchronous send to the members set profile photo route.
Declaration
public IAsyncResult BeginMembersSetProfilePhoto(MembersSetProfilePhotoArg membersSetProfilePhotoArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersSetProfilePhotoArg | membersSetProfilePhotoArg | 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. |
BeginMembersSetProfilePhoto(UserSelectorArg, PhotoSourceArg, AsyncCallback, Object)
Begins an asynchronous send to the members set profile photo route.
Declaration
public IAsyncResult BeginMembersSetProfilePhoto(UserSelectorArg user, PhotoSourceArg photo, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of the user whose profile photo will be set. |
PhotoSourceArg | photo | Image to set as the member's new profile photo. |
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. |
BeginMembersSetProfilePhotoV2(MembersSetProfilePhotoArg, AsyncCallback, Object)
Begins an asynchronous send to the members set profile photo route.
Declaration
public IAsyncResult BeginMembersSetProfilePhotoV2(MembersSetProfilePhotoArg membersSetProfilePhotoArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersSetProfilePhotoArg | membersSetProfilePhotoArg | 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. |
BeginMembersSetProfilePhotoV2(UserSelectorArg, PhotoSourceArg, AsyncCallback, Object)
Begins an asynchronous send to the members set profile photo route.
Declaration
public IAsyncResult BeginMembersSetProfilePhotoV2(UserSelectorArg user, PhotoSourceArg photo, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of the user whose profile photo will be set. |
PhotoSourceArg | photo | Image to set as the member's new profile photo. |
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. |
BeginMembersSetProfileV2(MembersSetProfileArg, AsyncCallback, Object)
Begins an asynchronous send to the members set profile route.
Declaration
public IAsyncResult BeginMembersSetProfileV2(MembersSetProfileArg membersSetProfileArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersSetProfileArg | membersSetProfileArg | 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. |
BeginMembersSetProfileV2(UserSelectorArg, String, String, String, String, String, Nullable<Boolean>, AsyncCallback, Object)
Begins an asynchronous send to the members set profile route.
Declaration
public IAsyncResult BeginMembersSetProfileV2(UserSelectorArg user, string newEmail = null, string newExternalId = null, string newGivenName = null, string newSurname = null, string newPersistentId = null, bool? newIsDirectoryRestricted = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user whose profile will be set. |
System.String | newEmail | New email for member. |
System.String | newExternalId | New external ID for member. |
System.String | newGivenName | New given name for member. |
System.String | newSurname | New surname for member. |
System.String | newPersistentId | New persistent ID. This field only available to teams using persistent ID SAML configuration. |
System.Nullable<System.Boolean> | newIsDirectoryRestricted | New value for whether the user is a directory restricted user. |
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. |
BeginMembersSuspend(MembersDeactivateArg, AsyncCallback, Object)
Begins an asynchronous send to the members suspend route.
Declaration
public IAsyncResult BeginMembersSuspend(MembersDeactivateArg membersDeactivateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersDeactivateArg | membersDeactivateArg | 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. |
BeginMembersSuspend(UserSelectorArg, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the members suspend route.
Declaration
public IAsyncResult BeginMembersSuspend(UserSelectorArg user, bool wipeData = true, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to remove/suspend/have their files moved. |
System.Boolean | wipeData | If provided, controls if the user's data will be deleted on their linked devices. |
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. |
BeginMembersUnsuspend(MembersUnsuspendArg, AsyncCallback, Object)
Begins an asynchronous send to the members unsuspend route.
Declaration
public IAsyncResult BeginMembersUnsuspend(MembersUnsuspendArg membersUnsuspendArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
MembersUnsuspendArg | membersUnsuspendArg | 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. |
BeginMembersUnsuspend(UserSelectorArg, AsyncCallback, Object)
Begins an asynchronous send to the members unsuspend route.
Declaration
public IAsyncResult BeginMembersUnsuspend(UserSelectorArg user, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to unsuspend. |
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. |
BeginNamespacesList(TeamNamespacesListArg, AsyncCallback, Object)
Begins an asynchronous send to the namespaces list route.
Declaration
public IAsyncResult BeginNamespacesList(TeamNamespacesListArg teamNamespacesListArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamNamespacesListArg | teamNamespacesListArg | 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. |
BeginNamespacesList(UInt32, AsyncCallback, Object)
Begins an asynchronous send to the namespaces list route.
Declaration
public IAsyncResult BeginNamespacesList(uint limit = 1000U, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Specifying a value here has no effect. |
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. |
BeginNamespacesListContinue(TeamNamespacesListContinueArg, AsyncCallback, Object)
Begins an asynchronous send to the namespaces list continue route.
Declaration
public IAsyncResult BeginNamespacesListContinue(TeamNamespacesListContinueArg teamNamespacesListContinueArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamNamespacesListContinueArg | teamNamespacesListContinueArg | 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. |
BeginNamespacesListContinue(String, AsyncCallback, Object)
Begins an asynchronous send to the namespaces list continue route.
Declaration
public IAsyncResult BeginNamespacesListContinue(string cursor, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of team-accessible namespaces. |
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. |
BeginPropertiesTemplateAdd(AddTemplateArg, AsyncCallback, Object)
Begins an asynchronous send to the properties template add route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateAdd(AddTemplateArg addTemplateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
AddTemplateArg | addTemplateArg | 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. |
BeginPropertiesTemplateAdd(String, String, IEnumerable<PropertyFieldTemplate>, AsyncCallback, Object)
Begins an asynchronous send to the properties template add route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateAdd(string name, string description, IEnumerable<PropertyFieldTemplate> fields, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Display name for the template. Template names can be up to 256 bytes. |
System.String | description | Description for the template. Template descriptions can be up to 1024 bytes. |
System.Collections.Generic.IEnumerable<PropertyFieldTemplate> | fields | Definitions of the property fields associated with this template. There can be up to 32 properties in a single template. |
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. |
BeginPropertiesTemplateGet(GetTemplateArg, AsyncCallback, Object)
Begins an asynchronous send to the properties template get route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateGet(GetTemplateArg getTemplateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
GetTemplateArg | getTemplateArg | 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. |
BeginPropertiesTemplateGet(String, AsyncCallback, Object)
Begins an asynchronous send to the properties template get route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateGet(string templateId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | An identifier for template added by route See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg). |
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. |
BeginPropertiesTemplateList(AsyncCallback, Object)
Begins an asynchronous send to the properties template list route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateList(AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
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. |
BeginPropertiesTemplateUpdate(UpdateTemplateArg, AsyncCallback, Object)
Begins an asynchronous send to the properties template update route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateUpdate(UpdateTemplateArg updateTemplateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
UpdateTemplateArg | updateTemplateArg | 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. |
BeginPropertiesTemplateUpdate(String, String, String, IEnumerable<PropertyFieldTemplate>, AsyncCallback, Object)
Begins an asynchronous send to the properties template update route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateUpdate(string templateId, string name = null, string description = null, IEnumerable<PropertyFieldTemplate> addFields = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | An identifier for template added by See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg). |
System.String | name | A display name for the template. template names can be up to 256 bytes. |
System.String | description | Description for the new template. Template descriptions can be up to 1024 bytes. |
System.Collections.Generic.IEnumerable<PropertyFieldTemplate> | addFields | Property field templates to be added to the group template. There can be up to 32 properties in a single template. |
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. |
BeginReportsGetActivity(DateRange, AsyncCallback, Object)
Begins an asynchronous send to the reports get activity route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginReportsGetActivity(DateRange dateRange, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
DateRange | dateRange | 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. |
BeginReportsGetActivity(Nullable<DateTime>, Nullable<DateTime>, AsyncCallback, Object)
Begins an asynchronous send to the reports get activity route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginReportsGetActivity(DateTime? startDate = null, DateTime? endDate = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.DateTime> | startDate | Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. |
System.Nullable<System.DateTime> | endDate | Optional ending date (exclusive). |
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. |
BeginReportsGetDevices(DateRange, AsyncCallback, Object)
Begins an asynchronous send to the reports get devices route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginReportsGetDevices(DateRange dateRange, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
DateRange | dateRange | 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. |
BeginReportsGetDevices(Nullable<DateTime>, Nullable<DateTime>, AsyncCallback, Object)
Begins an asynchronous send to the reports get devices route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginReportsGetDevices(DateTime? startDate = null, DateTime? endDate = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.DateTime> | startDate | Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. |
System.Nullable<System.DateTime> | endDate | Optional ending date (exclusive). |
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. |
BeginReportsGetMembership(DateRange, AsyncCallback, Object)
Begins an asynchronous send to the reports get membership route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginReportsGetMembership(DateRange dateRange, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
DateRange | dateRange | 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. |
BeginReportsGetMembership(Nullable<DateTime>, Nullable<DateTime>, AsyncCallback, Object)
Begins an asynchronous send to the reports get membership route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginReportsGetMembership(DateTime? startDate = null, DateTime? endDate = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.DateTime> | startDate | Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. |
System.Nullable<System.DateTime> | endDate | Optional ending date (exclusive). |
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. |
BeginReportsGetStorage(DateRange, AsyncCallback, Object)
Begins an asynchronous send to the reports get storage route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginReportsGetStorage(DateRange dateRange, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
DateRange | dateRange | 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. |
BeginReportsGetStorage(Nullable<DateTime>, Nullable<DateTime>, AsyncCallback, Object)
Begins an asynchronous send to the reports get storage route.
Declaration
[Obsolete("This function is deprecated")]
public IAsyncResult BeginReportsGetStorage(DateTime? startDate = null, DateTime? endDate = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.DateTime> | startDate | Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. |
System.Nullable<System.DateTime> | endDate | Optional ending date (exclusive). |
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. |
BeginTeamFolderActivate(TeamFolderIdArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder activate route.
Declaration
public IAsyncResult BeginTeamFolderActivate(TeamFolderIdArg teamFolderIdArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderIdArg | teamFolderIdArg | 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. |
BeginTeamFolderActivate(String, AsyncCallback, Object)
Begins an asynchronous send to the team folder activate route.
Declaration
public IAsyncResult BeginTeamFolderActivate(string teamFolderId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
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. |
BeginTeamFolderArchive(TeamFolderArchiveArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder archive route.
Declaration
public IAsyncResult BeginTeamFolderArchive(TeamFolderArchiveArg teamFolderArchiveArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderArchiveArg | teamFolderArchiveArg | 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. |
BeginTeamFolderArchive(String, Boolean, AsyncCallback, Object)
Begins an asynchronous send to the team folder archive route.
Declaration
public IAsyncResult BeginTeamFolderArchive(string teamFolderId, bool forceAsyncOff = false, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
System.Boolean | forceAsyncOff | Whether to force the archive to happen synchronously. |
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. |
BeginTeamFolderArchiveCheck(PollArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder archive check route.
Declaration
public IAsyncResult BeginTeamFolderArchiveCheck(PollArg pollArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | 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. |
BeginTeamFolderArchiveCheck(String, AsyncCallback, Object)
Begins an asynchronous send to the team folder archive check route.
Declaration
public IAsyncResult BeginTeamFolderArchiveCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
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. |
BeginTeamFolderCreate(TeamFolderCreateArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder create route.
Declaration
public IAsyncResult BeginTeamFolderCreate(TeamFolderCreateArg teamFolderCreateArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderCreateArg | teamFolderCreateArg | 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. |
BeginTeamFolderCreate(String, SyncSettingArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder create route.
Declaration
public IAsyncResult BeginTeamFolderCreate(string name, SyncSettingArg syncSetting = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name for the new team folder. |
SyncSettingArg | syncSetting | The sync setting to apply to this team folder. Only permitted if the team has team selective sync enabled. |
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. |
BeginTeamFolderGetInfo(TeamFolderIdListArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder get info route.
Declaration
public IAsyncResult BeginTeamFolderGetInfo(TeamFolderIdListArg teamFolderIdListArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderIdListArg | teamFolderIdListArg | 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. |
BeginTeamFolderGetInfo(IEnumerable<String>, AsyncCallback, Object)
Begins an asynchronous send to the team folder get info route.
Declaration
public IAsyncResult BeginTeamFolderGetInfo(IEnumerable<string> teamFolderIds, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.String> | teamFolderIds | The list of team folder IDs. |
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. |
BeginTeamFolderList(TeamFolderListArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder list route.
Declaration
public IAsyncResult BeginTeamFolderList(TeamFolderListArg teamFolderListArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderListArg | teamFolderListArg | 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. |
BeginTeamFolderList(UInt32, AsyncCallback, Object)
Begins an asynchronous send to the team folder list route.
Declaration
public IAsyncResult BeginTeamFolderList(uint limit = 1000U, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | The maximum number of results to return per request. |
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. |
BeginTeamFolderListContinue(TeamFolderListContinueArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder list continue route.
Declaration
public IAsyncResult BeginTeamFolderListContinue(TeamFolderListContinueArg teamFolderListContinueArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderListContinueArg | teamFolderListContinueArg | 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. |
BeginTeamFolderListContinue(String, AsyncCallback, Object)
Begins an asynchronous send to the team folder list continue route.
Declaration
public IAsyncResult BeginTeamFolderListContinue(string cursor, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of team folders. |
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. |
BeginTeamFolderPermanentlyDelete(TeamFolderIdArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder permanently delete route.
Declaration
public IAsyncResult BeginTeamFolderPermanentlyDelete(TeamFolderIdArg teamFolderIdArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderIdArg | teamFolderIdArg | 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. |
BeginTeamFolderPermanentlyDelete(String, AsyncCallback, Object)
Begins an asynchronous send to the team folder permanently delete route.
Declaration
public IAsyncResult BeginTeamFolderPermanentlyDelete(string teamFolderId, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
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. |
BeginTeamFolderRename(TeamFolderRenameArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder rename route.
Declaration
public IAsyncResult BeginTeamFolderRename(TeamFolderRenameArg teamFolderRenameArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderRenameArg | teamFolderRenameArg | 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. |
BeginTeamFolderRename(String, String, AsyncCallback, Object)
Begins an asynchronous send to the team folder rename route.
Declaration
public IAsyncResult BeginTeamFolderRename(string teamFolderId, string name, AsyncCallback callback, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
System.String | name | New team folder name. |
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. |
BeginTeamFolderUpdateSyncSettings(TeamFolderUpdateSyncSettingsArg, AsyncCallback, Object)
Begins an asynchronous send to the team folder update sync settings route.
Declaration
public IAsyncResult BeginTeamFolderUpdateSyncSettings(TeamFolderUpdateSyncSettingsArg teamFolderUpdateSyncSettingsArg, AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderUpdateSyncSettingsArg | teamFolderUpdateSyncSettingsArg | 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. |
BeginTeamFolderUpdateSyncSettings(String, SyncSettingArg, IEnumerable<ContentSyncSettingArg>, AsyncCallback, Object)
Begins an asynchronous send to the team folder update sync settings route.
Declaration
public IAsyncResult BeginTeamFolderUpdateSyncSettings(string teamFolderId, SyncSettingArg syncSetting = null, IEnumerable<ContentSyncSettingArg> contentSyncSettings = null, AsyncCallback callback = null, object callbackState = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
SyncSettingArg | syncSetting | Sync setting to apply to the team folder itself. Only meaningful if the team folder is not a shared team root. |
System.Collections.Generic.IEnumerable<ContentSyncSettingArg> | contentSyncSettings | Sync settings to apply to contents of this team folder. |
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. |
BeginTokenGetAuthenticatedAdmin(AsyncCallback, Object)
Begins an asynchronous send to the token get authenticated admin route.
Declaration
public IAsyncResult BeginTokenGetAuthenticatedAdmin(AsyncCallback callback, object state = null)
Parameters
Type | Name | Description |
---|---|---|
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. |
DevicesListMemberDevicesAsync(ListMemberDevicesArg)
List all device sessions of a team's member.
Declaration
public Task<ListMemberDevicesResult> DevicesListMemberDevicesAsync(ListMemberDevicesArg listMemberDevicesArg)
Parameters
Type | Name | Description |
---|---|---|
ListMemberDevicesArg | listMemberDevicesArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListMemberDevicesResult> | 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 ListMemberDevicesError. |
DevicesListMemberDevicesAsync(String, Boolean, Boolean, Boolean)
List all device sessions of a team's member.
Declaration
public Task<ListMemberDevicesResult> DevicesListMemberDevicesAsync(string teamMemberId, bool includeWebSessions = true, bool includeDesktopClients = true, bool includeMobileClients = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamMemberId | The team's member id. |
System.Boolean | includeWebSessions | Whether to list web sessions of the team's member. |
System.Boolean | includeDesktopClients | Whether to list linked desktop devices of the team's member. |
System.Boolean | includeMobileClients | Whether to list linked mobile devices of the team's member. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListMemberDevicesResult> | 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 ListMemberDevicesError. |
DevicesListMembersDevicesAsync(ListMembersDevicesArg)
List all device sessions of a team.
Permission : Team member file access.
Declaration
public Task<ListMembersDevicesResult> DevicesListMembersDevicesAsync(ListMembersDevicesArg listMembersDevicesArg)
Parameters
Type | Name | Description |
---|---|---|
ListMembersDevicesArg | listMembersDevicesArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListMembersDevicesResult> | 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 ListMembersDevicesError. |
DevicesListMembersDevicesAsync(String, Boolean, Boolean, Boolean)
List all device sessions of a team.
Permission : Team member file access.
Declaration
public Task<ListMembersDevicesResult> DevicesListMembersDevicesAsync(string cursor = null, bool includeWebSessions = true, bool includeDesktopClients = true, bool includeMobileClients = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | At the first call to the DevicesListMembersDevicesAsync(ListMembersDevicesArg) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices. |
System.Boolean | includeWebSessions | Whether to list web sessions of the team members. |
System.Boolean | includeDesktopClients | Whether to list desktop clients of the team members. |
System.Boolean | includeMobileClients | Whether to list mobile clients of the team members. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListMembersDevicesResult> | 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 ListMembersDevicesError. |
DevicesListTeamDevicesAsync(ListTeamDevicesArg)
List all device sessions of a team.
Permission : Team member file access.
Declaration
[Obsolete("This function is deprecated, please use DevicesListMembersDevicesAsync instead.")]
public Task<ListTeamDevicesResult> DevicesListTeamDevicesAsync(ListTeamDevicesArg listTeamDevicesArg)
Parameters
Type | Name | Description |
---|---|---|
ListTeamDevicesArg | listTeamDevicesArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListTeamDevicesResult> | 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 ListTeamDevicesError. |
DevicesListTeamDevicesAsync(String, Boolean, Boolean, Boolean)
List all device sessions of a team.
Permission : Team member file access.
Declaration
[Obsolete("This function is deprecated, please use DevicesListMembersDevicesAsync instead.")]
public Task<ListTeamDevicesResult> DevicesListTeamDevicesAsync(string cursor = null, bool includeWebSessions = true, bool includeDesktopClients = true, bool includeMobileClients = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | At the first call to the DevicesListTeamDevicesAsync(ListTeamDevicesArg) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices. |
System.Boolean | includeWebSessions | Whether to list web sessions of the team members. |
System.Boolean | includeDesktopClients | Whether to list desktop clients of the team members. |
System.Boolean | includeMobileClients | Whether to list mobile clients of the team members. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListTeamDevicesResult> | 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 ListTeamDevicesError. |
DevicesRevokeDeviceSessionAsync(RevokeDeviceSessionArg)
Revoke a device session of a team's member.
Declaration
public Task DevicesRevokeDeviceSessionAsync(RevokeDeviceSessionArg revokeDeviceSessionArg)
Parameters
Type | Name | Description |
---|---|---|
RevokeDeviceSessionArg | revokeDeviceSessionArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a RevokeDeviceSessionError. |
DevicesRevokeDeviceSessionBatchAsync(RevokeDeviceSessionBatchArg)
Revoke a list of device sessions of team members.
Declaration
public Task<RevokeDeviceSessionBatchResult> DevicesRevokeDeviceSessionBatchAsync(RevokeDeviceSessionBatchArg revokeDeviceSessionBatchArg)
Parameters
Type | Name | Description |
---|---|---|
RevokeDeviceSessionBatchArg | revokeDeviceSessionBatchArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RevokeDeviceSessionBatchResult> | 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 RevokeDeviceSessionBatchError. |
DevicesRevokeDeviceSessionBatchAsync(IEnumerable<RevokeDeviceSessionArg>)
Revoke a list of device sessions of team members.
Declaration
public Task<RevokeDeviceSessionBatchResult> DevicesRevokeDeviceSessionBatchAsync(IEnumerable<RevokeDeviceSessionArg> revokeDevices)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<RevokeDeviceSessionArg> | revokeDevices | The revoke devices |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RevokeDeviceSessionBatchResult> | 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 RevokeDeviceSessionBatchError. |
EndDevicesListMemberDevices(IAsyncResult)
Waits for the pending asynchronous send to the devices list member devices route to complete
Declaration
public ListMemberDevicesResult EndDevicesListMemberDevices(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ListMemberDevicesResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ListMemberDevicesError. |
EndDevicesListMembersDevices(IAsyncResult)
Waits for the pending asynchronous send to the devices list members devices route to complete
Declaration
public ListMembersDevicesResult EndDevicesListMembersDevices(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ListMembersDevicesResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ListMembersDevicesError. |
EndDevicesListTeamDevices(IAsyncResult)
Waits for the pending asynchronous send to the devices list team devices route to complete
Declaration
[Obsolete("This function is deprecated, please use EndDevicesListMembersDevices instead.")]
public ListTeamDevicesResult EndDevicesListTeamDevices(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ListTeamDevicesResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ListTeamDevicesError. |
EndDevicesRevokeDeviceSession(IAsyncResult)
Waits for the pending asynchronous send to the devices revoke device session route to complete
Declaration
public void EndDevicesRevokeDeviceSession(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a RevokeDeviceSessionError. |
EndDevicesRevokeDeviceSessionBatch(IAsyncResult)
Waits for the pending asynchronous send to the devices revoke device session batch route to complete
Declaration
public RevokeDeviceSessionBatchResult EndDevicesRevokeDeviceSessionBatch(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
RevokeDeviceSessionBatchResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a RevokeDeviceSessionBatchError. |
EndFeaturesGetValues(IAsyncResult)
Waits for the pending asynchronous send to the features get values route to complete
Declaration
public FeaturesGetValuesBatchResult EndFeaturesGetValues(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
FeaturesGetValuesBatchResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a FeaturesGetValuesBatchError. |
EndGetInfo(IAsyncResult)
Waits for the pending asynchronous send to the get info route to complete
Declaration
public TeamGetInfoResult EndGetInfo(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamGetInfoResult | The response to the send request |
EndGroupsCreate(IAsyncResult)
Waits for the pending asynchronous send to the groups create route to complete
Declaration
public GroupFullInfo EndGroupsCreate(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GroupFullInfo | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupCreateError. |
EndGroupsDelete(IAsyncResult)
Waits for the pending asynchronous send to the groups delete route to complete
Declaration
public LaunchEmptyResult EndGroupsDelete(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LaunchEmptyResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupDeleteError. |
EndGroupsGetInfo(IAsyncResult)
Waits for the pending asynchronous send to the groups get info route to complete
Declaration
public List<GroupsGetInfoItem> EndGroupsGetInfo(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<GroupsGetInfoItem> | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupsGetInfoError. |
EndGroupsJobStatusGet(IAsyncResult)
Waits for the pending asynchronous send to the groups job status get route to complete
Declaration
public PollEmptyResult EndGroupsJobStatusGet(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
PollEmptyResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupsPollError. |
EndGroupsList(IAsyncResult)
Waits for the pending asynchronous send to the groups list route to complete
Declaration
public GroupsListResult EndGroupsList(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GroupsListResult | The response to the send request |
EndGroupsListContinue(IAsyncResult)
Waits for the pending asynchronous send to the groups list continue route to complete
Declaration
public GroupsListResult EndGroupsListContinue(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GroupsListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupsListContinueError. |
EndGroupsMembersAdd(IAsyncResult)
Waits for the pending asynchronous send to the groups members add route to complete
Declaration
public GroupMembersChangeResult EndGroupsMembersAdd(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GroupMembersChangeResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupMembersAddError. |
EndGroupsMembersList(IAsyncResult)
Waits for the pending asynchronous send to the groups members list route to complete
Declaration
public GroupsMembersListResult EndGroupsMembersList(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GroupsMembersListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupSelectorError. |
EndGroupsMembersListContinue(IAsyncResult)
Waits for the pending asynchronous send to the groups members list continue route to complete
Declaration
public GroupsMembersListResult EndGroupsMembersListContinue(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GroupsMembersListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupsMembersListContinueError. |
EndGroupsMembersRemove(IAsyncResult)
Waits for the pending asynchronous send to the groups members remove route to complete
Declaration
public GroupMembersChangeResult EndGroupsMembersRemove(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GroupMembersChangeResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupMembersRemoveError. |
EndGroupsMembersSetAccessType(IAsyncResult)
Waits for the pending asynchronous send to the groups members set access type route to complete
Declaration
public List<GroupsGetInfoItem> EndGroupsMembersSetAccessType(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<GroupsGetInfoItem> | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupMemberSetAccessTypeError. |
EndGroupsUpdate(IAsyncResult)
Waits for the pending asynchronous send to the groups update route to complete
Declaration
public GroupFullInfo EndGroupsUpdate(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GroupFullInfo | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a GroupUpdateError. |
EndLegalHoldsCreatePolicy(IAsyncResult)
Waits for the pending asynchronous send to the legal holds create policy route to complete
Declaration
public LegalHoldPolicy EndLegalHoldsCreatePolicy(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LegalHoldPolicy | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsPolicyCreateError. |
EndLegalHoldsGetPolicy(IAsyncResult)
Waits for the pending asynchronous send to the legal holds get policy route to complete
Declaration
public LegalHoldPolicy EndLegalHoldsGetPolicy(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LegalHoldPolicy | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsGetPolicyError. |
EndLegalHoldsListHeldRevisions(IAsyncResult)
Waits for the pending asynchronous send to the legal holds list held revisions route to complete
Declaration
public LegalHoldsListHeldRevisionResult EndLegalHoldsListHeldRevisions(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LegalHoldsListHeldRevisionResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsListHeldRevisionsError. |
EndLegalHoldsListHeldRevisionsContinue(IAsyncResult)
Waits for the pending asynchronous send to the legal holds list held revisions continue route to complete
Declaration
public LegalHoldsListHeldRevisionResult EndLegalHoldsListHeldRevisionsContinue(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LegalHoldsListHeldRevisionResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsListHeldRevisionsError. |
EndLegalHoldsListPolicies(IAsyncResult)
Waits for the pending asynchronous send to the legal holds list policies route to complete
Declaration
public LegalHoldsListPoliciesResult EndLegalHoldsListPolicies(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LegalHoldsListPoliciesResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsListPoliciesError. |
EndLegalHoldsReleasePolicy(IAsyncResult)
Waits for the pending asynchronous send to the legal holds release policy route to complete
Declaration
public void EndLegalHoldsReleasePolicy(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsPolicyReleaseError. |
EndLegalHoldsUpdatePolicy(IAsyncResult)
Waits for the pending asynchronous send to the legal holds update policy route to complete
Declaration
public LegalHoldPolicy EndLegalHoldsUpdatePolicy(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LegalHoldPolicy | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsPolicyUpdateError. |
EndLinkedAppsListMemberLinkedApps(IAsyncResult)
Waits for the pending asynchronous send to the linked apps list member linked apps route to complete
Declaration
public ListMemberAppsResult EndLinkedAppsListMemberLinkedApps(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ListMemberAppsResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ListMemberAppsError. |
EndLinkedAppsListMembersLinkedApps(IAsyncResult)
Waits for the pending asynchronous send to the linked apps list members linked apps route to complete
Declaration
public ListMembersAppsResult EndLinkedAppsListMembersLinkedApps(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ListMembersAppsResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ListMembersAppsError. |
EndLinkedAppsListTeamLinkedApps(IAsyncResult)
Waits for the pending asynchronous send to the linked apps list team linked apps route to complete
Declaration
[Obsolete("This function is deprecated, please use EndLinkedAppsListMembersLinkedApps instead.")]
public ListTeamAppsResult EndLinkedAppsListTeamLinkedApps(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ListTeamAppsResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ListTeamAppsError. |
EndLinkedAppsRevokeLinkedApp(IAsyncResult)
Waits for the pending asynchronous send to the linked apps revoke linked app route to complete
Declaration
public void EndLinkedAppsRevokeLinkedApp(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a RevokeLinkedAppError. |
EndLinkedAppsRevokeLinkedAppBatch(IAsyncResult)
Waits for the pending asynchronous send to the linked apps revoke linked app batch route to complete
Declaration
public RevokeLinkedAppBatchResult EndLinkedAppsRevokeLinkedAppBatch(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
RevokeLinkedAppBatchResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a RevokeLinkedAppBatchError. |
EndMembersAdd(IAsyncResult)
Waits for the pending asynchronous send to the members add route to complete
Declaration
public MembersAddLaunch EndMembersAdd(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersAddLaunch | The response to the send request |
EndMembersAddJobStatusGet(IAsyncResult)
Waits for the pending asynchronous send to the members add job status get route to complete
Declaration
public MembersAddJobStatus EndMembersAddJobStatusGet(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersAddJobStatus | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a PollError. |
EndMembersAddJobStatusGetV2(IAsyncResult)
Waits for the pending asynchronous send to the members add job status get route to complete
Declaration
public MembersAddJobStatusV2Result EndMembersAddJobStatusGetV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersAddJobStatusV2Result | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a PollError. |
EndMembersAddV2(IAsyncResult)
Waits for the pending asynchronous send to the members add route to complete
Declaration
public MembersAddLaunchV2Result EndMembersAddV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersAddLaunchV2Result | The response to the send request |
EndMembersDeleteProfilePhoto(IAsyncResult)
Waits for the pending asynchronous send to the members delete profile photo route to complete
Declaration
public TeamMemberInfo EndMembersDeleteProfilePhoto(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamMemberInfo | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersDeleteProfilePhotoError. |
EndMembersDeleteProfilePhotoV2(IAsyncResult)
Waits for the pending asynchronous send to the members delete profile photo route to complete
Declaration
public TeamMemberInfoV2Result EndMembersDeleteProfilePhotoV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamMemberInfoV2Result | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersDeleteProfilePhotoError. |
EndMembersGetAvailableTeamMemberRoles(IAsyncResult)
Waits for the pending asynchronous send to the members get available team member roles route to complete
Declaration
public MembersGetAvailableTeamMemberRolesResult EndMembersGetAvailableTeamMemberRoles(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersGetAvailableTeamMemberRolesResult | The response to the send request |
EndMembersGetInfo(IAsyncResult)
Waits for the pending asynchronous send to the members get info route to complete
Declaration
public List<MembersGetInfoItem> EndMembersGetInfo(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<MembersGetInfoItem> | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersGetInfoError. |
EndMembersGetInfoV2(IAsyncResult)
Waits for the pending asynchronous send to the members get info route to complete
Declaration
public MembersGetInfoV2Result EndMembersGetInfoV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersGetInfoV2Result | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersGetInfoError. |
EndMembersList(IAsyncResult)
Waits for the pending asynchronous send to the members list route to complete
Declaration
public MembersListResult EndMembersList(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersListError. |
EndMembersListContinue(IAsyncResult)
Waits for the pending asynchronous send to the members list continue route to complete
Declaration
public MembersListResult EndMembersListContinue(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersListContinueError. |
EndMembersListContinueV2(IAsyncResult)
Waits for the pending asynchronous send to the members list continue route to complete
Declaration
public MembersListV2Result EndMembersListContinueV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersListV2Result | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersListContinueError. |
EndMembersListV2(IAsyncResult)
Waits for the pending asynchronous send to the members list route to complete
Declaration
public MembersListV2Result EndMembersListV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersListV2Result | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersListError. |
EndMembersMoveFormerMemberFiles(IAsyncResult)
Waits for the pending asynchronous send to the members move former member files route to complete
Declaration
public LaunchEmptyResult EndMembersMoveFormerMemberFiles(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LaunchEmptyResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersTransferFormerMembersFilesError. |
EndMembersMoveFormerMemberFilesJobStatusCheck(IAsyncResult)
Waits for the pending asynchronous send to the members move former member files job status check route to complete
Declaration
public PollEmptyResult EndMembersMoveFormerMemberFilesJobStatusCheck(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
PollEmptyResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a PollError. |
EndMemberSpaceLimitsExcludedUsersAdd(IAsyncResult)
Waits for the pending asynchronous send to the member space limits excluded users add route to complete
Declaration
public ExcludedUsersUpdateResult EndMemberSpaceLimitsExcludedUsersAdd(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ExcludedUsersUpdateResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ExcludedUsersUpdateError. |
EndMemberSpaceLimitsExcludedUsersList(IAsyncResult)
Waits for the pending asynchronous send to the member space limits excluded users list route to complete
Declaration
public ExcludedUsersListResult EndMemberSpaceLimitsExcludedUsersList(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ExcludedUsersListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ExcludedUsersListError. |
EndMemberSpaceLimitsExcludedUsersListContinue(IAsyncResult)
Waits for the pending asynchronous send to the member space limits excluded users list continue route to complete
Declaration
public ExcludedUsersListResult EndMemberSpaceLimitsExcludedUsersListContinue(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ExcludedUsersListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ExcludedUsersListContinueError. |
EndMemberSpaceLimitsExcludedUsersRemove(IAsyncResult)
Waits for the pending asynchronous send to the member space limits excluded users remove route to complete
Declaration
public ExcludedUsersUpdateResult EndMemberSpaceLimitsExcludedUsersRemove(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ExcludedUsersUpdateResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ExcludedUsersUpdateError. |
EndMemberSpaceLimitsGetCustomQuota(IAsyncResult)
Waits for the pending asynchronous send to the member space limits get custom quota route to complete
Declaration
public List<CustomQuotaResult> EndMemberSpaceLimitsGetCustomQuota(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<CustomQuotaResult> | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a CustomQuotaError. |
EndMemberSpaceLimitsRemoveCustomQuota(IAsyncResult)
Waits for the pending asynchronous send to the member space limits remove custom quota route to complete
Declaration
public List<RemoveCustomQuotaResult> EndMemberSpaceLimitsRemoveCustomQuota(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<RemoveCustomQuotaResult> | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a CustomQuotaError. |
EndMemberSpaceLimitsSetCustomQuota(IAsyncResult)
Waits for the pending asynchronous send to the member space limits set custom quota route to complete
Declaration
public List<CustomQuotaResult> EndMemberSpaceLimitsSetCustomQuota(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<CustomQuotaResult> | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a SetCustomQuotaError. |
EndMembersRecover(IAsyncResult)
Waits for the pending asynchronous send to the members recover route to complete
Declaration
public void EndMembersRecover(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersRecoverError. |
EndMembersRemove(IAsyncResult)
Waits for the pending asynchronous send to the members remove route to complete
Declaration
public LaunchEmptyResult EndMembersRemove(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
LaunchEmptyResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersRemoveError. |
EndMembersRemoveJobStatusGet(IAsyncResult)
Waits for the pending asynchronous send to the members remove job status get route to complete
Declaration
public PollEmptyResult EndMembersRemoveJobStatusGet(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
PollEmptyResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a PollError. |
EndMembersSecondaryEmailsAdd(IAsyncResult)
Waits for the pending asynchronous send to the members secondary emails add route to complete
Declaration
public AddSecondaryEmailsResult EndMembersSecondaryEmailsAdd(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
AddSecondaryEmailsResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a AddSecondaryEmailsError. |
EndMembersSecondaryEmailsDelete(IAsyncResult)
Waits for the pending asynchronous send to the members secondary emails delete route to complete
Declaration
public DeleteSecondaryEmailsResult EndMembersSecondaryEmailsDelete(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
DeleteSecondaryEmailsResult | The response to the send request |
EndMembersSecondaryEmailsResendVerificationEmails(IAsyncResult)
Waits for the pending asynchronous send to the members secondary emails resend verification emails route to complete
Declaration
public ResendVerificationEmailResult EndMembersSecondaryEmailsResendVerificationEmails(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ResendVerificationEmailResult | The response to the send request |
EndMembersSendWelcomeEmail(IAsyncResult)
Waits for the pending asynchronous send to the members send welcome email route to complete
Declaration
public void EndMembersSendWelcomeEmail(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSendWelcomeError. |
EndMembersSetAdminPermissions(IAsyncResult)
Waits for the pending asynchronous send to the members set admin permissions route to complete
Declaration
public MembersSetPermissionsResult EndMembersSetAdminPermissions(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersSetPermissionsResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSetPermissionsError. |
EndMembersSetAdminPermissionsV2(IAsyncResult)
Waits for the pending asynchronous send to the members set admin permissions route to complete
Declaration
public MembersSetPermissions2Result EndMembersSetAdminPermissionsV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
MembersSetPermissions2Result | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSetPermissions2Error. |
EndMembersSetProfile(IAsyncResult)
Waits for the pending asynchronous send to the members set profile route to complete
Declaration
public TeamMemberInfo EndMembersSetProfile(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamMemberInfo | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSetProfileError. |
EndMembersSetProfilePhoto(IAsyncResult)
Waits for the pending asynchronous send to the members set profile photo route to complete
Declaration
public TeamMemberInfo EndMembersSetProfilePhoto(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamMemberInfo | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSetProfilePhotoError. |
EndMembersSetProfilePhotoV2(IAsyncResult)
Waits for the pending asynchronous send to the members set profile photo route to complete
Declaration
public TeamMemberInfoV2Result EndMembersSetProfilePhotoV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamMemberInfoV2Result | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSetProfilePhotoError. |
EndMembersSetProfileV2(IAsyncResult)
Waits for the pending asynchronous send to the members set profile route to complete
Declaration
public TeamMemberInfoV2Result EndMembersSetProfileV2(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamMemberInfoV2Result | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSetProfileError. |
EndMembersSuspend(IAsyncResult)
Waits for the pending asynchronous send to the members suspend route to complete
Declaration
public void EndMembersSuspend(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSuspendError. |
EndMembersUnsuspend(IAsyncResult)
Waits for the pending asynchronous send to the members unsuspend route to complete
Declaration
public void EndMembersUnsuspend(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersUnsuspendError. |
EndNamespacesList(IAsyncResult)
Waits for the pending asynchronous send to the namespaces list route to complete
Declaration
public TeamNamespacesListResult EndNamespacesList(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamNamespacesListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamNamespacesListError. |
EndNamespacesListContinue(IAsyncResult)
Waits for the pending asynchronous send to the namespaces list continue route to complete
Declaration
public TeamNamespacesListResult EndNamespacesListContinue(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamNamespacesListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamNamespacesListContinueError. |
EndPropertiesTemplateAdd(IAsyncResult)
Waits for the pending asynchronous send to the properties template add route to complete
Declaration
[Obsolete("This function is deprecated")]
public AddTemplateResult EndPropertiesTemplateAdd(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
AddTemplateResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ModifyTemplateError. |
EndPropertiesTemplateGet(IAsyncResult)
Waits for the pending asynchronous send to the properties template get route to complete
Declaration
[Obsolete("This function is deprecated")]
public GetTemplateResult EndPropertiesTemplateGet(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GetTemplateResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TemplateError. |
EndPropertiesTemplateList(IAsyncResult)
Waits for the pending asynchronous send to the properties template list route to complete
Declaration
[Obsolete("This function is deprecated")]
public ListTemplateResult EndPropertiesTemplateList(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
ListTemplateResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TemplateError. |
EndPropertiesTemplateUpdate(IAsyncResult)
Waits for the pending asynchronous send to the properties template update route to complete
Declaration
[Obsolete("This function is deprecated")]
public UpdateTemplateResult EndPropertiesTemplateUpdate(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
UpdateTemplateResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a ModifyTemplateError. |
EndReportsGetActivity(IAsyncResult)
Waits for the pending asynchronous send to the reports get activity route to complete
Declaration
[Obsolete("This function is deprecated")]
public GetActivityReport EndReportsGetActivity(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GetActivityReport | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a DateRangeError. |
EndReportsGetDevices(IAsyncResult)
Waits for the pending asynchronous send to the reports get devices route to complete
Declaration
[Obsolete("This function is deprecated")]
public GetDevicesReport EndReportsGetDevices(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GetDevicesReport | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a DateRangeError. |
EndReportsGetMembership(IAsyncResult)
Waits for the pending asynchronous send to the reports get membership route to complete
Declaration
[Obsolete("This function is deprecated")]
public GetMembershipReport EndReportsGetMembership(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GetMembershipReport | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a DateRangeError. |
EndReportsGetStorage(IAsyncResult)
Waits for the pending asynchronous send to the reports get storage route to complete
Declaration
[Obsolete("This function is deprecated")]
public GetStorageReport EndReportsGetStorage(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
GetStorageReport | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a DateRangeError. |
EndTeamFolderActivate(IAsyncResult)
Waits for the pending asynchronous send to the team folder activate route to complete
Declaration
public TeamFolderMetadata EndTeamFolderActivate(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamFolderMetadata | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderActivateError. |
EndTeamFolderArchive(IAsyncResult)
Waits for the pending asynchronous send to the team folder archive route to complete
Declaration
public TeamFolderArchiveLaunch EndTeamFolderArchive(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamFolderArchiveLaunch | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderArchiveError. |
EndTeamFolderArchiveCheck(IAsyncResult)
Waits for the pending asynchronous send to the team folder archive check route to complete
Declaration
public TeamFolderArchiveJobStatus EndTeamFolderArchiveCheck(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamFolderArchiveJobStatus | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a PollError. |
EndTeamFolderCreate(IAsyncResult)
Waits for the pending asynchronous send to the team folder create route to complete
Declaration
public TeamFolderMetadata EndTeamFolderCreate(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamFolderMetadata | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderCreateError. |
EndTeamFolderGetInfo(IAsyncResult)
Waits for the pending asynchronous send to the team folder get info route to complete
Declaration
public List<TeamFolderGetInfoItem> EndTeamFolderGetInfo(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<TeamFolderGetInfoItem> | The response to the send request |
EndTeamFolderList(IAsyncResult)
Waits for the pending asynchronous send to the team folder list route to complete
Declaration
public TeamFolderListResult EndTeamFolderList(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamFolderListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderListError. |
EndTeamFolderListContinue(IAsyncResult)
Waits for the pending asynchronous send to the team folder list continue route to complete
Declaration
public TeamFolderListResult EndTeamFolderListContinue(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamFolderListResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderListContinueError. |
EndTeamFolderPermanentlyDelete(IAsyncResult)
Waits for the pending asynchronous send to the team folder permanently delete route to complete
Declaration
public void EndTeamFolderPermanentlyDelete(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderPermanentlyDeleteError. |
EndTeamFolderRename(IAsyncResult)
Waits for the pending asynchronous send to the team folder rename route to complete
Declaration
public TeamFolderMetadata EndTeamFolderRename(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamFolderMetadata | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderRenameError. |
EndTeamFolderUpdateSyncSettings(IAsyncResult)
Waits for the pending asynchronous send to the team folder update sync settings route to complete
Declaration
public TeamFolderMetadata EndTeamFolderUpdateSyncSettings(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TeamFolderMetadata | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderUpdateSyncSettingsError. |
EndTokenGetAuthenticatedAdmin(IAsyncResult)
Waits for the pending asynchronous send to the token get authenticated admin route to complete
Declaration
public TokenGetAuthenticatedAdminResult EndTokenGetAuthenticatedAdmin(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
System.IAsyncResult | asyncResult | The reference to the pending asynchronous send request |
Returns
Type | Description |
---|---|
TokenGetAuthenticatedAdminResult | The response to the send request |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TokenGetAuthenticatedAdminError. |
FeaturesGetValuesAsync(FeaturesGetValuesBatchArg)
Get the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features.
Permission : Team information.
Declaration
public Task<FeaturesGetValuesBatchResult> FeaturesGetValuesAsync(FeaturesGetValuesBatchArg featuresGetValuesBatchArg)
Parameters
Type | Name | Description |
---|---|---|
FeaturesGetValuesBatchArg | featuresGetValuesBatchArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FeaturesGetValuesBatchResult> | 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 FeaturesGetValuesBatchError. |
FeaturesGetValuesAsync(IEnumerable<Feature>)
Get the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features.
Permission : Team information.
Declaration
public Task<FeaturesGetValuesBatchResult> FeaturesGetValuesAsync(IEnumerable<Feature> features)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<Feature> | features | A list of features in Feature. If the list is empty, this route will return FeaturesGetValuesBatchError. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FeaturesGetValuesBatchResult> | 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 FeaturesGetValuesBatchError. |
GetInfoAsync()
Retrieves information about a team.
Declaration
public Task<TeamGetInfoResult> GetInfoAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamGetInfoResult> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
GroupsCreateAsync(GroupCreateArg)
Creates a new, empty group, with a requested name.
Permission : Team member management.
Declaration
public Task<GroupFullInfo> GroupsCreateAsync(GroupCreateArg groupCreateArg)
Parameters
Type | Name | Description |
---|---|---|
GroupCreateArg | groupCreateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupFullInfo> | 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 GroupCreateError. |
GroupsCreateAsync(String, Boolean, String, GroupManagementType)
Creates a new, empty group, with a requested name.
Permission : Team member management.
Declaration
public Task<GroupFullInfo> GroupsCreateAsync(string groupName, bool addCreatorAsOwner = false, string groupExternalId = null, GroupManagementType groupManagementType = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | groupName | Group name. |
System.Boolean | addCreatorAsOwner | Automatically add the creator of the group. |
System.String | groupExternalId | The creator of a team can associate an arbitrary external ID to the group. |
GroupManagementType | groupManagementType | Whether the team can be managed by selected users, or only by team admins. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupFullInfo> | 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 GroupCreateError. |
GroupsDeleteAsync(GroupSelector)
Deletes a group.
The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the GroupsJobStatusGetAsync(PollArg) to determine whether this process has completed.
Permission : Team member management.
Declaration
public Task<LaunchEmptyResult> GroupsDeleteAsync(GroupSelector groupSelector)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | groupSelector | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LaunchEmptyResult> | 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 GroupDeleteError. |
GroupsGetInfoAsync(GroupsSelector)
Retrieves information about one or more groups. Note that the optional field Members is not returned for system-managed groups.
Permission : Team Information.
Declaration
public Task<List<GroupsGetInfoItem>> GroupsGetInfoAsync(GroupsSelector groupsSelector)
Parameters
Type | Name | Description |
---|---|---|
GroupsSelector | groupsSelector | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<GroupsGetInfoItem>> | 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 GroupsGetInfoError. |
GroupsJobStatusGetAsync(PollArg)
Once an async_job_id is returned from GroupsDeleteAsync(GroupSelector), GroupsMembersAddAsync(GroupMembersAddArg) , or GroupsMembersRemoveAsync(GroupMembersRemoveArg) use this method to poll the status of granting/revoking group members' access to group-owned resources.
Permission : Team member management.
Declaration
public Task<PollEmptyResult> GroupsJobStatusGetAsync(PollArg pollArg)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PollEmptyResult> | 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 GroupsPollError. |
GroupsJobStatusGetAsync(String)
Once an async_job_id is returned from GroupsDeleteAsync(GroupSelector), GroupsMembersAddAsync(GroupMembersAddArg) , or GroupsMembersRemoveAsync(GroupMembersRemoveArg) use this method to poll the status of granting/revoking group members' access to group-owned resources.
Permission : Team member management.
Declaration
public Task<PollEmptyResult> GroupsJobStatusGetAsync(string asyncJobId)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PollEmptyResult> | 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 GroupsPollError. |
GroupsListAsync(GroupsListArg)
Lists groups on a team.
Permission : Team Information.
Declaration
public Task<GroupsListResult> GroupsListAsync(GroupsListArg groupsListArg)
Parameters
Type | Name | Description |
---|---|---|
GroupsListArg | groupsListArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupsListResult> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
GroupsListAsync(UInt32)
Lists groups on a team.
Permission : Team Information.
Declaration
public Task<GroupsListResult> GroupsListAsync(uint limit = 1000U)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Number of results to return per call. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupsListResult> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
GroupsListContinueAsync(GroupsListContinueArg)
Once a cursor has been retrieved from GroupsListAsync(GroupsListArg), use this to paginate through all groups.
Permission : Team Information.
Declaration
public Task<GroupsListResult> GroupsListContinueAsync(GroupsListContinueArg groupsListContinueArg)
Parameters
Type | Name | Description |
---|---|---|
GroupsListContinueArg | groupsListContinueArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupsListResult> | 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 GroupsListContinueError. |
GroupsListContinueAsync(String)
Once a cursor has been retrieved from GroupsListAsync(GroupsListArg), use this to paginate through all groups.
Permission : Team Information.
Declaration
public Task<GroupsListResult> GroupsListContinueAsync(string cursor)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of groups. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupsListResult> | 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 GroupsListContinueError. |
GroupsMembersAddAsync(GroupMembersAddArg)
Adds members to a group.
The members are added immediately. However the granting of group-owned resources may take additional time. Use the GroupsJobStatusGetAsync(PollArg) to determine whether this process has completed.
Permission : Team member management.
Declaration
public Task<GroupMembersChangeResult> GroupsMembersAddAsync(GroupMembersAddArg groupMembersAddArg)
Parameters
Type | Name | Description |
---|---|---|
GroupMembersAddArg | groupMembersAddArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupMembersChangeResult> | 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 GroupMembersAddError. |
GroupsMembersAddAsync(GroupSelector, IEnumerable<MemberAccess>, Boolean)
Adds members to a group.
The members are added immediately. However the granting of group-owned resources may take additional time. Use the GroupsJobStatusGetAsync(PollArg) to determine whether this process has completed.
Permission : Team member management.
Declaration
public Task<GroupMembersChangeResult> GroupsMembersAddAsync(GroupSelector group, IEnumerable<MemberAccess> members, bool returnMembers = true)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | Group to which users will be added. |
System.Collections.Generic.IEnumerable<MemberAccess> | members | List of users to be added to the group. |
System.Boolean | returnMembers | Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupMembersChangeResult> | 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 GroupMembersAddError. |
GroupsMembersListAsync(GroupSelector, UInt32)
Lists members of a group.
Permission : Team Information.
Declaration
public Task<GroupsMembersListResult> GroupsMembersListAsync(GroupSelector group, uint limit = 1000U)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | The group whose members are to be listed. |
System.UInt32 | limit | Number of results to return per call. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupsMembersListResult> | 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 GroupSelectorError. |
GroupsMembersListAsync(GroupsMembersListArg)
Lists members of a group.
Permission : Team Information.
Declaration
public Task<GroupsMembersListResult> GroupsMembersListAsync(GroupsMembersListArg groupsMembersListArg)
Parameters
Type | Name | Description |
---|---|---|
GroupsMembersListArg | groupsMembersListArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupsMembersListResult> | 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 GroupSelectorError. |
GroupsMembersListContinueAsync(GroupsMembersListContinueArg)
Once a cursor has been retrieved from GroupsMembersListAsync(GroupsMembersListArg), use this to paginate through all members of the group.
Permission : Team information.
Declaration
public Task<GroupsMembersListResult> GroupsMembersListContinueAsync(GroupsMembersListContinueArg groupsMembersListContinueArg)
Parameters
Type | Name | Description |
---|---|---|
GroupsMembersListContinueArg | groupsMembersListContinueArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupsMembersListResult> | 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 GroupsMembersListContinueError. |
GroupsMembersListContinueAsync(String)
Once a cursor has been retrieved from GroupsMembersListAsync(GroupsMembersListArg), use this to paginate through all members of the group.
Permission : Team information.
Declaration
public Task<GroupsMembersListResult> GroupsMembersListContinueAsync(string cursor)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of groups. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupsMembersListResult> | 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 GroupsMembersListContinueError. |
GroupsMembersRemoveAsync(GroupMembersRemoveArg)
Removes members from a group.
The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the GroupsJobStatusGetAsync(PollArg) to determine whether this process has completed.
This method permits removing the only owner of a group, even in cases where this is not possible via the web client.
Permission : Team member management.
Declaration
public Task<GroupMembersChangeResult> GroupsMembersRemoveAsync(GroupMembersRemoveArg groupMembersRemoveArg)
Parameters
Type | Name | Description |
---|---|---|
GroupMembersRemoveArg | groupMembersRemoveArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupMembersChangeResult> | 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 GroupMembersRemoveError. |
GroupsMembersRemoveAsync(GroupSelector, IEnumerable<UserSelectorArg>, Boolean)
Removes members from a group.
The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the GroupsJobStatusGetAsync(PollArg) to determine whether this process has completed.
This method permits removing the only owner of a group, even in cases where this is not possible via the web client.
Permission : Team member management.
Declaration
public Task<GroupMembersChangeResult> GroupsMembersRemoveAsync(GroupSelector group, IEnumerable<UserSelectorArg> users, bool returnMembers = true)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | Group from which users will be removed. |
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users to be removed from the group. |
System.Boolean | returnMembers | Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupMembersChangeResult> | 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 GroupMembersRemoveError. |
GroupsMembersSetAccessTypeAsync(GroupMembersSetAccessTypeArg)
Sets a member's access type in a group.
Permission : Team member management.
Declaration
public Task<List<GroupsGetInfoItem>> GroupsMembersSetAccessTypeAsync(GroupMembersSetAccessTypeArg groupMembersSetAccessTypeArg)
Parameters
Type | Name | Description |
---|---|---|
GroupMembersSetAccessTypeArg | groupMembersSetAccessTypeArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<GroupsGetInfoItem>> | 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 GroupMemberSetAccessTypeError. |
GroupsMembersSetAccessTypeAsync(GroupSelector, UserSelectorArg, GroupAccessType, Boolean)
Sets a member's access type in a group.
Permission : Team member management.
Declaration
public Task<List<GroupsGetInfoItem>> GroupsMembersSetAccessTypeAsync(GroupSelector group, UserSelectorArg user, GroupAccessType accessType, bool returnMembers = true)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | Specify a group. |
UserSelectorArg | user | Identity of a user that is a member of |
GroupAccessType | accessType | New group access type the user will have. |
System.Boolean | returnMembers | Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<GroupsGetInfoItem>> | 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 GroupMemberSetAccessTypeError. |
GroupsUpdateAsync(GroupSelector, Boolean, String, String, GroupManagementType)
Updates a group's name and/or external ID.
Permission : Team member management.
Declaration
public Task<GroupFullInfo> GroupsUpdateAsync(GroupSelector group, bool returnMembers = true, string newGroupName = null, string newGroupExternalId = null, GroupManagementType newGroupManagementType = null)
Parameters
Type | Name | Description |
---|---|---|
GroupSelector | group | Specify a group. |
System.Boolean | returnMembers | Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. |
System.String | newGroupName | Optional argument. Set group name to this if provided. |
System.String | newGroupExternalId | Optional argument. New group external ID. If the argument is None, the group's external_id won't be updated. If the argument is empty string, the group's external id will be cleared. |
GroupManagementType | newGroupManagementType | Set new group management type, if provided. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupFullInfo> | 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 GroupUpdateError. |
GroupsUpdateAsync(GroupUpdateArgs)
Updates a group's name and/or external ID.
Permission : Team member management.
Declaration
public Task<GroupFullInfo> GroupsUpdateAsync(GroupUpdateArgs groupUpdateArgs)
Parameters
Type | Name | Description |
---|---|---|
GroupUpdateArgs | groupUpdateArgs | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GroupFullInfo> | 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 GroupUpdateError. |
LegalHoldsCreatePolicyAsync(LegalHoldsPolicyCreateArg)
Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldPolicy> LegalHoldsCreatePolicyAsync(LegalHoldsPolicyCreateArg legalHoldsPolicyCreateArg)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsPolicyCreateArg | legalHoldsPolicyCreateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldPolicy> | 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 LegalHoldsPolicyCreateError. |
LegalHoldsCreatePolicyAsync(String, IEnumerable<String>, String, Nullable<DateTime>, Nullable<DateTime>)
Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldPolicy> LegalHoldsCreatePolicyAsync(string name, IEnumerable<string> members, string description = null, DateTime? startDate = null, DateTime? endDate = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Policy name. |
System.Collections.Generic.IEnumerable<System.String> | members | List of team member IDs added to the hold. |
System.String | description | A description of the legal hold policy. |
System.Nullable<System.DateTime> | startDate | start date of the legal hold policy. |
System.Nullable<System.DateTime> | endDate | end date of the legal hold policy. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldPolicy> | 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 LegalHoldsPolicyCreateError. |
LegalHoldsGetPolicyAsync(LegalHoldsGetPolicyArg)
Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldPolicy> LegalHoldsGetPolicyAsync(LegalHoldsGetPolicyArg legalHoldsGetPolicyArg)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsGetPolicyArg | legalHoldsGetPolicyArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldPolicy> | 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 LegalHoldsGetPolicyError. |
LegalHoldsGetPolicyAsync(String)
Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldPolicy> LegalHoldsGetPolicyAsync(string id)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldPolicy> | 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 LegalHoldsGetPolicyError. |
LegalHoldsListHeldRevisionsAsync(LegalHoldsListHeldRevisionsArg)
List the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldsListHeldRevisionResult> LegalHoldsListHeldRevisionsAsync(LegalHoldsListHeldRevisionsArg legalHoldsListHeldRevisionsArg)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsListHeldRevisionsArg | legalHoldsListHeldRevisionsArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldsListHeldRevisionResult> | 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 LegalHoldsListHeldRevisionsError. |
LegalHoldsListHeldRevisionsAsync(String)
List the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldsListHeldRevisionResult> LegalHoldsListHeldRevisionsAsync(string id)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldsListHeldRevisionResult> | 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 LegalHoldsListHeldRevisionsError. |
LegalHoldsListHeldRevisionsContinueAsync(LegalHoldsListHeldRevisionsContinueArg)
Continue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldsListHeldRevisionResult> LegalHoldsListHeldRevisionsContinueAsync(LegalHoldsListHeldRevisionsContinueArg legalHoldsListHeldRevisionsContinueArg)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsListHeldRevisionsContinueArg | legalHoldsListHeldRevisionsContinueArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldsListHeldRevisionResult> | 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 LegalHoldsListHeldRevisionsError. |
LegalHoldsListHeldRevisionsContinueAsync(String, String)
Continue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldsListHeldRevisionResult> LegalHoldsListHeldRevisionsContinueAsync(string id, string cursor = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
System.String | cursor | The cursor idicates where to continue reading file metadata entries for the next API call. When there are no more entries, the cursor will return none. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldsListHeldRevisionResult> | 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 LegalHoldsListHeldRevisionsError. |
LegalHoldsListPoliciesAsync(LegalHoldsListPoliciesArg)
Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldsListPoliciesResult> LegalHoldsListPoliciesAsync(LegalHoldsListPoliciesArg legalHoldsListPoliciesArg)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsListPoliciesArg | legalHoldsListPoliciesArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldsListPoliciesResult> | 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 LegalHoldsListPoliciesError. |
LegalHoldsListPoliciesAsync(Boolean)
Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldsListPoliciesResult> LegalHoldsListPoliciesAsync(bool includeReleased = false)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | includeReleased | Whether to return holds that were released. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldsListPoliciesResult> | 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 LegalHoldsListPoliciesError. |
LegalHoldsReleasePolicyAsync(LegalHoldsPolicyReleaseArg)
Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task LegalHoldsReleasePolicyAsync(LegalHoldsPolicyReleaseArg legalHoldsPolicyReleaseArg)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsPolicyReleaseArg | legalHoldsPolicyReleaseArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsPolicyReleaseError. |
LegalHoldsReleasePolicyAsync(String)
Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task LegalHoldsReleasePolicyAsync(string id)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a LegalHoldsPolicyReleaseError. |
LegalHoldsUpdatePolicyAsync(LegalHoldsPolicyUpdateArg)
Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldPolicy> LegalHoldsUpdatePolicyAsync(LegalHoldsPolicyUpdateArg legalHoldsPolicyUpdateArg)
Parameters
Type | Name | Description |
---|---|---|
LegalHoldsPolicyUpdateArg | legalHoldsPolicyUpdateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldPolicy> | 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 LegalHoldsPolicyUpdateError. |
LegalHoldsUpdatePolicyAsync(String, String, String, IEnumerable<String>)
Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.
Permission : Team member file access.
Declaration
public Task<LegalHoldPolicy> LegalHoldsUpdatePolicyAsync(string id, string name = null, string description = null, IEnumerable<string> members = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | id | The legal hold Id. |
System.String | name | Policy new name. |
System.String | description | Policy new description. |
System.Collections.Generic.IEnumerable<System.String> | members | List of team member IDs to apply the policy on. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LegalHoldPolicy> | 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 LegalHoldsPolicyUpdateError. |
LinkedAppsListMemberLinkedAppsAsync(ListMemberAppsArg)
List all linked applications of the team member.
Note, this endpoint does not list any team-linked applications.
Declaration
public Task<ListMemberAppsResult> LinkedAppsListMemberLinkedAppsAsync(ListMemberAppsArg listMemberAppsArg)
Parameters
Type | Name | Description |
---|---|---|
ListMemberAppsArg | listMemberAppsArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListMemberAppsResult> | 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 ListMemberAppsError. |
LinkedAppsListMemberLinkedAppsAsync(String)
List all linked applications of the team member.
Note, this endpoint does not list any team-linked applications.
Declaration
public Task<ListMemberAppsResult> LinkedAppsListMemberLinkedAppsAsync(string teamMemberId)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamMemberId | The team member id. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListMemberAppsResult> | 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 ListMemberAppsError. |
LinkedAppsListMembersLinkedAppsAsync(ListMembersAppsArg)
List all applications linked to the team members' accounts.
Note, this endpoint does not list any team-linked applications.
Declaration
public Task<ListMembersAppsResult> LinkedAppsListMembersLinkedAppsAsync(ListMembersAppsArg listMembersAppsArg)
Parameters
Type | Name | Description |
---|---|---|
ListMembersAppsArg | listMembersAppsArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListMembersAppsResult> | 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 ListMembersAppsError. |
LinkedAppsListMembersLinkedAppsAsync(String)
List all applications linked to the team members' accounts.
Note, this endpoint does not list any team-linked applications.
Declaration
public Task<ListMembersAppsResult> LinkedAppsListMembersLinkedAppsAsync(string cursor = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | At the first call to the LinkedAppsListMembersLinkedAppsAsync(ListMembersAppsArg) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListMembersAppsResult> | 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 ListMembersAppsError. |
LinkedAppsListTeamLinkedAppsAsync(ListTeamAppsArg)
List all applications linked to the team members' accounts.
Note, this endpoint doesn't list any team-linked applications.
Declaration
[Obsolete("This function is deprecated, please use LinkedAppsListMembersLinkedAppsAsync instead.")]
public Task<ListTeamAppsResult> LinkedAppsListTeamLinkedAppsAsync(ListTeamAppsArg listTeamAppsArg)
Parameters
Type | Name | Description |
---|---|---|
ListTeamAppsArg | listTeamAppsArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListTeamAppsResult> | 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 ListTeamAppsError. |
LinkedAppsListTeamLinkedAppsAsync(String)
List all applications linked to the team members' accounts.
Note, this endpoint doesn't list any team-linked applications.
Declaration
[Obsolete("This function is deprecated, please use LinkedAppsListMembersLinkedAppsAsync instead.")]
public Task<ListTeamAppsResult> LinkedAppsListTeamLinkedAppsAsync(string cursor = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | At the first call to the LinkedAppsListTeamLinkedAppsAsync(ListTeamAppsArg) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListTeamAppsResult> | 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 ListTeamAppsError. |
LinkedAppsRevokeLinkedAppAsync(RevokeLinkedApiAppArg)
Revoke a linked application of the team member.
Declaration
public Task LinkedAppsRevokeLinkedAppAsync(RevokeLinkedApiAppArg revokeLinkedApiAppArg)
Parameters
Type | Name | Description |
---|---|---|
RevokeLinkedApiAppArg | revokeLinkedApiAppArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a RevokeLinkedAppError. |
LinkedAppsRevokeLinkedAppAsync(String, String, Boolean)
Revoke a linked application of the team member.
Declaration
public Task LinkedAppsRevokeLinkedAppAsync(string appId, string teamMemberId, bool keepAppFolder = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | appId | The application's unique id. |
System.String | teamMemberId | The unique id of the member owning the device. |
System.Boolean | keepAppFolder | This flag is not longer supported, the application dedicated folder (in case the application uses one) will be kept. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a RevokeLinkedAppError. |
LinkedAppsRevokeLinkedAppBatchAsync(RevokeLinkedApiAppBatchArg)
Revoke a list of linked applications of the team members.
Declaration
public Task<RevokeLinkedAppBatchResult> LinkedAppsRevokeLinkedAppBatchAsync(RevokeLinkedApiAppBatchArg revokeLinkedApiAppBatchArg)
Parameters
Type | Name | Description |
---|---|---|
RevokeLinkedApiAppBatchArg | revokeLinkedApiAppBatchArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RevokeLinkedAppBatchResult> | 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 RevokeLinkedAppBatchError. |
LinkedAppsRevokeLinkedAppBatchAsync(IEnumerable<RevokeLinkedApiAppArg>)
Revoke a list of linked applications of the team members.
Declaration
public Task<RevokeLinkedAppBatchResult> LinkedAppsRevokeLinkedAppBatchAsync(IEnumerable<RevokeLinkedApiAppArg> revokeLinkedApp)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<RevokeLinkedApiAppArg> | revokeLinkedApp | The revoke linked app |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RevokeLinkedAppBatchResult> | 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 RevokeLinkedAppBatchError. |
MembersAddAsync(MembersAddArg)
Adds members to a team.
Permission : Team member management
A maximum of 20 members can be specified in a single call.
If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.
If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.
Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.
Declaration
public Task<MembersAddLaunch> MembersAddAsync(MembersAddArg membersAddArg)
Parameters
Type | Name | Description |
---|---|---|
MembersAddArg | membersAddArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersAddLaunch> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersAddAsync(IEnumerable<MemberAddArg>, Boolean)
Adds members to a team.
Permission : Team member management
A maximum of 20 members can be specified in a single call.
If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.
If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.
Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.
Declaration
public Task<MembersAddLaunch> MembersAddAsync(IEnumerable<MemberAddArg> newMembers, bool forceAsync = false)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<MemberAddArg> | newMembers | Details of new members to be added to the team. |
System.Boolean | forceAsync | Whether to force the add to happen asynchronously. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersAddLaunch> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersAddJobStatusGetAsync(PollArg)
Once an async_job_id is returned from MembersAddAsync(MembersAddArg) , use this to poll the status of the asynchronous request.
Permission : Team member management.
Declaration
public Task<MembersAddJobStatus> MembersAddJobStatusGetAsync(PollArg pollArg)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersAddJobStatus> | 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 PollError. |
MembersAddJobStatusGetAsync(String)
Once an async_job_id is returned from MembersAddAsync(MembersAddArg) , use this to poll the status of the asynchronous request.
Permission : Team member management.
Declaration
public Task<MembersAddJobStatus> MembersAddJobStatusGetAsync(string asyncJobId)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersAddJobStatus> | 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 PollError. |
MembersAddJobStatusGetV2Async(PollArg)
Once an async_job_id is returned from MembersAddV2Async(MembersAddV2Arg) , use this to poll the status of the asynchronous request.
Permission : Team member management.
Declaration
public Task<MembersAddJobStatusV2Result> MembersAddJobStatusGetV2Async(PollArg pollArg)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersAddJobStatusV2Result> | 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 PollError. |
MembersAddJobStatusGetV2Async(String)
Once an async_job_id is returned from MembersAddV2Async(MembersAddV2Arg) , use this to poll the status of the asynchronous request.
Permission : Team member management.
Declaration
public Task<MembersAddJobStatusV2Result> MembersAddJobStatusGetV2Async(string asyncJobId)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersAddJobStatusV2Result> | 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 PollError. |
MembersAddV2Async(MembersAddV2Arg)
Adds members to a team.
Permission : Team member management
A maximum of 20 members can be specified in a single call.
If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.
If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.
Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.
Declaration
public Task<MembersAddLaunchV2Result> MembersAddV2Async(MembersAddV2Arg membersAddV2Arg)
Parameters
Type | Name | Description |
---|---|---|
MembersAddV2Arg | membersAddV2Arg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersAddLaunchV2Result> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersAddV2Async(IEnumerable<MemberAddV2Arg>, Boolean)
Adds members to a team.
Permission : Team member management
A maximum of 20 members can be specified in a single call.
If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.
If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.
Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.
Declaration
public Task<MembersAddLaunchV2Result> MembersAddV2Async(IEnumerable<MemberAddV2Arg> newMembers, bool forceAsync = false)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<MemberAddV2Arg> | newMembers | Details of new members to be added to the team. |
System.Boolean | forceAsync | Whether to force the add to happen asynchronously. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersAddLaunchV2Result> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersDeleteProfilePhotoAsync(MembersDeleteProfilePhotoArg)
Deletes a team member's profile photo.
Permission : Team member management.
Declaration
public Task<TeamMemberInfo> MembersDeleteProfilePhotoAsync(MembersDeleteProfilePhotoArg membersDeleteProfilePhotoArg)
Parameters
Type | Name | Description |
---|---|---|
MembersDeleteProfilePhotoArg | membersDeleteProfilePhotoArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfo> | 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 MembersDeleteProfilePhotoError. |
MembersDeleteProfilePhotoAsync(UserSelectorArg)
Deletes a team member's profile photo.
Permission : Team member management.
Declaration
public Task<TeamMemberInfo> MembersDeleteProfilePhotoAsync(UserSelectorArg user)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of the user whose profile photo will be deleted. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfo> | 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 MembersDeleteProfilePhotoError. |
MembersDeleteProfilePhotoV2Async(MembersDeleteProfilePhotoArg)
Deletes a team member's profile photo.
Permission : Team member management.
Declaration
public Task<TeamMemberInfoV2Result> MembersDeleteProfilePhotoV2Async(MembersDeleteProfilePhotoArg membersDeleteProfilePhotoArg)
Parameters
Type | Name | Description |
---|---|---|
MembersDeleteProfilePhotoArg | membersDeleteProfilePhotoArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfoV2Result> | 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 MembersDeleteProfilePhotoError. |
MembersDeleteProfilePhotoV2Async(UserSelectorArg)
Deletes a team member's profile photo.
Permission : Team member management.
Declaration
public Task<TeamMemberInfoV2Result> MembersDeleteProfilePhotoV2Async(UserSelectorArg user)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of the user whose profile photo will be deleted. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfoV2Result> | 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 MembersDeleteProfilePhotoError. |
MembersGetAvailableTeamMemberRolesAsync()
Get available TeamMemberRoles for the connected team. To be used with MembersSetAdminPermissionsV2Async(MembersSetPermissions2Arg).
Permission : Team member management.
Declaration
public Task<MembersGetAvailableTeamMemberRolesResult> MembersGetAvailableTeamMemberRolesAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersGetAvailableTeamMemberRolesResult> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersGetInfoAsync(MembersGetInfoArgs)
Returns information about multiple team members.
Permission : Team information
This endpoint will return MembersGetInfoItem.IdNotFound, for IDs (or emails) that cannot be matched to a valid team member.
Declaration
public Task<List<MembersGetInfoItem>> MembersGetInfoAsync(MembersGetInfoArgs membersGetInfoArgs)
Parameters
Type | Name | Description |
---|---|---|
MembersGetInfoArgs | membersGetInfoArgs | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<MembersGetInfoItem>> | 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 MembersGetInfoError. |
MembersGetInfoAsync(IEnumerable<UserSelectorArg>)
Returns information about multiple team members.
Permission : Team information
This endpoint will return MembersGetInfoItem.IdNotFound, for IDs (or emails) that cannot be matched to a valid team member.
Declaration
public Task<List<MembersGetInfoItem>> MembersGetInfoAsync(IEnumerable<UserSelectorArg> members)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | members | List of team members. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<MembersGetInfoItem>> | 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 MembersGetInfoError. |
MembersGetInfoV2Async(MembersGetInfoV2Arg)
Returns information about multiple team members.
Permission : Team information
This endpoint will return MembersGetInfoItem.IdNotFound, for IDs (or emails) that cannot be matched to a valid team member.
Declaration
public Task<MembersGetInfoV2Result> MembersGetInfoV2Async(MembersGetInfoV2Arg membersGetInfoV2Arg)
Parameters
Type | Name | Description |
---|---|---|
MembersGetInfoV2Arg | membersGetInfoV2Arg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersGetInfoV2Result> | 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 MembersGetInfoError. |
MembersGetInfoV2Async(IEnumerable<UserSelectorArg>)
Returns information about multiple team members.
Permission : Team information
This endpoint will return MembersGetInfoItem.IdNotFound, for IDs (or emails) that cannot be matched to a valid team member.
Declaration
public Task<MembersGetInfoV2Result> MembersGetInfoV2Async(IEnumerable<UserSelectorArg> members)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | members | List of team members. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersGetInfoV2Result> | 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 MembersGetInfoError. |
MembersListAsync(MembersListArg)
Lists members of a team.
Permission : Team information.
Declaration
public Task<MembersListResult> MembersListAsync(MembersListArg membersListArg)
Parameters
Type | Name | Description |
---|---|---|
MembersListArg | membersListArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersListResult> | 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 MembersListError. |
MembersListAsync(UInt32, Boolean)
Lists members of a team.
Permission : Team information.
Declaration
public Task<MembersListResult> MembersListAsync(uint limit = 1000U, bool includeRemoved = false)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Number of results to return per call. |
System.Boolean | includeRemoved | Whether to return removed members. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersListResult> | 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 MembersListError. |
MembersListContinueAsync(MembersListContinueArg)
Once a cursor has been retrieved from MembersListAsync(MembersListArg), use this to paginate through all team members.
Permission : Team information.
Declaration
public Task<MembersListResult> MembersListContinueAsync(MembersListContinueArg membersListContinueArg)
Parameters
Type | Name | Description |
---|---|---|
MembersListContinueArg | membersListContinueArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersListResult> | 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 MembersListContinueError. |
MembersListContinueAsync(String)
Once a cursor has been retrieved from MembersListAsync(MembersListArg), use this to paginate through all team members.
Permission : Team information.
Declaration
public Task<MembersListResult> MembersListContinueAsync(string cursor)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of members. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersListResult> | 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 MembersListContinueError. |
MembersListContinueV2Async(MembersListContinueArg)
Once a cursor has been retrieved from MembersListV2Async(MembersListArg), use this to paginate through all team members.
Permission : Team information.
Declaration
public Task<MembersListV2Result> MembersListContinueV2Async(MembersListContinueArg membersListContinueArg)
Parameters
Type | Name | Description |
---|---|---|
MembersListContinueArg | membersListContinueArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersListV2Result> | 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 MembersListContinueError. |
MembersListContinueV2Async(String)
Once a cursor has been retrieved from MembersListV2Async(MembersListArg), use this to paginate through all team members.
Permission : Team information.
Declaration
public Task<MembersListV2Result> MembersListContinueV2Async(string cursor)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of members. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersListV2Result> | 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 MembersListContinueError. |
MembersListV2Async(MembersListArg)
Lists members of a team.
Permission : Team information.
Declaration
public Task<MembersListV2Result> MembersListV2Async(MembersListArg membersListArg)
Parameters
Type | Name | Description |
---|---|---|
MembersListArg | membersListArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersListV2Result> | 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 MembersListError. |
MembersListV2Async(UInt32, Boolean)
Lists members of a team.
Permission : Team information.
Declaration
public Task<MembersListV2Result> MembersListV2Async(uint limit = 1000U, bool includeRemoved = false)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Number of results to return per call. |
System.Boolean | includeRemoved | Whether to return removed members. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersListV2Result> | 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 MembersListError. |
MembersMoveFormerMemberFilesAsync(MembersDataTransferArg)
Moves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll MembersMoveFormerMemberFilesJobStatusCheckAsync(PollArg).
Permission : Team member management.
Declaration
public Task<LaunchEmptyResult> MembersMoveFormerMemberFilesAsync(MembersDataTransferArg membersDataTransferArg)
Parameters
Type | Name | Description |
---|---|---|
MembersDataTransferArg | membersDataTransferArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LaunchEmptyResult> | 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 MembersTransferFormerMembersFilesError. |
MembersMoveFormerMemberFilesAsync(UserSelectorArg, UserSelectorArg, UserSelectorArg)
Moves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll MembersMoveFormerMemberFilesJobStatusCheckAsync(PollArg).
Permission : Team member management.
Declaration
public Task<LaunchEmptyResult> MembersMoveFormerMemberFilesAsync(UserSelectorArg user, UserSelectorArg transferDestId, UserSelectorArg transferAdminId)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to remove/suspend/have their files moved. |
UserSelectorArg | transferDestId | Files from the deleted member account will be transferred to this user. |
UserSelectorArg | transferAdminId | Errors during the transfer process will be sent via email to this user. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LaunchEmptyResult> | 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 MembersTransferFormerMembersFilesError. |
MembersMoveFormerMemberFilesJobStatusCheckAsync(PollArg)
Once an async_job_id is returned from MembersMoveFormerMemberFilesAsync(MembersDataTransferArg) , use this to poll the status of the asynchronous request.
Permission : Team member management.
Declaration
public Task<PollEmptyResult> MembersMoveFormerMemberFilesJobStatusCheckAsync(PollArg pollArg)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PollEmptyResult> | 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 PollError. |
MembersMoveFormerMemberFilesJobStatusCheckAsync(String)
Once an async_job_id is returned from MembersMoveFormerMemberFilesAsync(MembersDataTransferArg) , use this to poll the status of the asynchronous request.
Permission : Team member management.
Declaration
public Task<PollEmptyResult> MembersMoveFormerMemberFilesJobStatusCheckAsync(string asyncJobId)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PollEmptyResult> | 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 PollError. |
MemberSpaceLimitsExcludedUsersAddAsync(ExcludedUsersUpdateArg)
Add users to member space limits excluded users list.
Declaration
public Task<ExcludedUsersUpdateResult> MemberSpaceLimitsExcludedUsersAddAsync(ExcludedUsersUpdateArg excludedUsersUpdateArg)
Parameters
Type | Name | Description |
---|---|---|
ExcludedUsersUpdateArg | excludedUsersUpdateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExcludedUsersUpdateResult> | 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 ExcludedUsersUpdateError. |
MemberSpaceLimitsExcludedUsersAddAsync(IEnumerable<UserSelectorArg>)
Add users to member space limits excluded users list.
Declaration
public Task<ExcludedUsersUpdateResult> MemberSpaceLimitsExcludedUsersAddAsync(IEnumerable<UserSelectorArg> users = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users to be added/removed. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExcludedUsersUpdateResult> | 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 ExcludedUsersUpdateError. |
MemberSpaceLimitsExcludedUsersListAsync(ExcludedUsersListArg)
List member space limits excluded users.
Declaration
public Task<ExcludedUsersListResult> MemberSpaceLimitsExcludedUsersListAsync(ExcludedUsersListArg excludedUsersListArg)
Parameters
Type | Name | Description |
---|---|---|
ExcludedUsersListArg | excludedUsersListArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExcludedUsersListResult> | 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 ExcludedUsersListError. |
MemberSpaceLimitsExcludedUsersListAsync(UInt32)
List member space limits excluded users.
Declaration
public Task<ExcludedUsersListResult> MemberSpaceLimitsExcludedUsersListAsync(uint limit = 1000U)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Number of results to return per call. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExcludedUsersListResult> | 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 ExcludedUsersListError. |
MemberSpaceLimitsExcludedUsersListContinueAsync(ExcludedUsersListContinueArg)
Continue listing member space limits excluded users.
Declaration
public Task<ExcludedUsersListResult> MemberSpaceLimitsExcludedUsersListContinueAsync(ExcludedUsersListContinueArg excludedUsersListContinueArg)
Parameters
Type | Name | Description |
---|---|---|
ExcludedUsersListContinueArg | excludedUsersListContinueArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExcludedUsersListResult> | 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 ExcludedUsersListContinueError. |
MemberSpaceLimitsExcludedUsersListContinueAsync(String)
Continue listing member space limits excluded users.
Declaration
public Task<ExcludedUsersListResult> MemberSpaceLimitsExcludedUsersListContinueAsync(string cursor)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of users. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExcludedUsersListResult> | 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 ExcludedUsersListContinueError. |
MemberSpaceLimitsExcludedUsersRemoveAsync(ExcludedUsersUpdateArg)
Remove users from member space limits excluded users list.
Declaration
public Task<ExcludedUsersUpdateResult> MemberSpaceLimitsExcludedUsersRemoveAsync(ExcludedUsersUpdateArg excludedUsersUpdateArg)
Parameters
Type | Name | Description |
---|---|---|
ExcludedUsersUpdateArg | excludedUsersUpdateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExcludedUsersUpdateResult> | 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 ExcludedUsersUpdateError. |
MemberSpaceLimitsExcludedUsersRemoveAsync(IEnumerable<UserSelectorArg>)
Remove users from member space limits excluded users list.
Declaration
public Task<ExcludedUsersUpdateResult> MemberSpaceLimitsExcludedUsersRemoveAsync(IEnumerable<UserSelectorArg> users = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users to be added/removed. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExcludedUsersUpdateResult> | 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 ExcludedUsersUpdateError. |
MemberSpaceLimitsGetCustomQuotaAsync(CustomQuotaUsersArg)
Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.
Declaration
public Task<List<CustomQuotaResult>> MemberSpaceLimitsGetCustomQuotaAsync(CustomQuotaUsersArg customQuotaUsersArg)
Parameters
Type | Name | Description |
---|---|---|
CustomQuotaUsersArg | customQuotaUsersArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<CustomQuotaResult>> | 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 CustomQuotaError. |
MemberSpaceLimitsGetCustomQuotaAsync(IEnumerable<UserSelectorArg>)
Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.
Declaration
public Task<List<CustomQuotaResult>> MemberSpaceLimitsGetCustomQuotaAsync(IEnumerable<UserSelectorArg> users)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<CustomQuotaResult>> | 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 CustomQuotaError. |
MemberSpaceLimitsRemoveCustomQuotaAsync(CustomQuotaUsersArg)
Remove users custom quota. A maximum of 1000 members can be specified in a single call.
Declaration
public Task<List<RemoveCustomQuotaResult>> MemberSpaceLimitsRemoveCustomQuotaAsync(CustomQuotaUsersArg customQuotaUsersArg)
Parameters
Type | Name | Description |
---|---|---|
CustomQuotaUsersArg | customQuotaUsersArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<RemoveCustomQuotaResult>> | 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 CustomQuotaError. |
MemberSpaceLimitsRemoveCustomQuotaAsync(IEnumerable<UserSelectorArg>)
Remove users custom quota. A maximum of 1000 members can be specified in a single call.
Declaration
public Task<List<RemoveCustomQuotaResult>> MemberSpaceLimitsRemoveCustomQuotaAsync(IEnumerable<UserSelectorArg> users)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSelectorArg> | users | List of users. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<RemoveCustomQuotaResult>> | 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 CustomQuotaError. |
MemberSpaceLimitsSetCustomQuotaAsync(SetCustomQuotaArg)
Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.
Declaration
public Task<List<CustomQuotaResult>> MemberSpaceLimitsSetCustomQuotaAsync(SetCustomQuotaArg setCustomQuotaArg)
Parameters
Type | Name | Description |
---|---|---|
SetCustomQuotaArg | setCustomQuotaArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<CustomQuotaResult>> | 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 SetCustomQuotaError. |
MemberSpaceLimitsSetCustomQuotaAsync(IEnumerable<UserCustomQuotaArg>)
Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.
Declaration
public Task<List<CustomQuotaResult>> MemberSpaceLimitsSetCustomQuotaAsync(IEnumerable<UserCustomQuotaArg> usersAndQuotas)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserCustomQuotaArg> | usersAndQuotas | List of users and their custom quotas. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<CustomQuotaResult>> | 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 SetCustomQuotaError. |
MembersRecoverAsync(MembersRecoverArg)
Recover a deleted member.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Declaration
public Task MembersRecoverAsync(MembersRecoverArg membersRecoverArg)
Parameters
Type | Name | Description |
---|---|---|
MembersRecoverArg | membersRecoverArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersRecoverError. |
MembersRecoverAsync(UserSelectorArg)
Recover a deleted member.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Declaration
public Task MembersRecoverAsync(UserSelectorArg user)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to recover. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersRecoverError. |
MembersRemoveAsync(MembersRemoveArg)
Removes a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Accounts can be recovered via MembersRecoverAsync(MembersRecoverArg) for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling MembersAddAsync(MembersAddArg) while a user is still recoverable on your team will return with MemberAddResult.UserAlreadyOnTeam.
Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams).
This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll MembersRemoveJobStatusGetAsync(PollArg).
Declaration
public Task<LaunchEmptyResult> MembersRemoveAsync(MembersRemoveArg membersRemoveArg)
Parameters
Type | Name | Description |
---|---|---|
MembersRemoveArg | membersRemoveArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LaunchEmptyResult> | 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 MembersRemoveError. |
MembersRemoveAsync(UserSelectorArg, Boolean, UserSelectorArg, UserSelectorArg, Boolean, Boolean)
Removes a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Accounts can be recovered via MembersRecoverAsync(MembersRecoverArg) for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling MembersAddAsync(MembersAddArg) while a user is still recoverable on your team will return with MemberAddResult.UserAlreadyOnTeam.
Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams).
This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll MembersRemoveJobStatusGetAsync(PollArg).
Declaration
public Task<LaunchEmptyResult> MembersRemoveAsync(UserSelectorArg user, bool wipeData = true, UserSelectorArg transferDestId = null, UserSelectorArg transferAdminId = null, bool keepAccount = false, bool retainTeamShares = false)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to remove/suspend/have their files moved. |
System.Boolean | wipeData | If provided, controls if the user's data will be deleted on their linked devices. |
UserSelectorArg | transferDestId | If provided, files from the deleted member account will be transferred to this user. |
UserSelectorArg | transferAdminId | If provided, errors during the transfer process will be sent via email to this user. If the transfer_dest_id argument was provided, then this argument must be provided as well. |
System.Boolean | keepAccount | Downgrade the member to a Basic account. The user will
retain the email address associated with their Dropbox account and data in their
account that is not restricted to team members. In order to keep the account the
argument |
System.Boolean | retainTeamShares | If provided, allows removed users to keep access to
Dropbox folders (not Dropbox Paper folders) already explicitly shared with them
(not via a group) when they are downgraded to a Basic account. Users will not
retain access to folders that do not allow external sharing. In order to keep the
sharing relationships, the arguments |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LaunchEmptyResult> | 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 MembersRemoveError. |
MembersRemoveJobStatusGetAsync(PollArg)
Once an async_job_id is returned from MembersRemoveAsync(MembersRemoveArg) , use this to poll the status of the asynchronous request.
Permission : Team member management.
Declaration
public Task<PollEmptyResult> MembersRemoveJobStatusGetAsync(PollArg pollArg)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PollEmptyResult> | 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 PollError. |
MembersRemoveJobStatusGetAsync(String)
Once an async_job_id is returned from MembersRemoveAsync(MembersRemoveArg) , use this to poll the status of the asynchronous request.
Permission : Team member management.
Declaration
public Task<PollEmptyResult> MembersRemoveJobStatusGetAsync(string asyncJobId)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<PollEmptyResult> | 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 PollError. |
MembersSecondaryEmailsAddAsync(AddSecondaryEmailsArg)
Add secondary emails to users.
Permission : Team member management.
Emails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent.
Declaration
public Task<AddSecondaryEmailsResult> MembersSecondaryEmailsAddAsync(AddSecondaryEmailsArg addSecondaryEmailsArg)
Parameters
Type | Name | Description |
---|---|---|
AddSecondaryEmailsArg | addSecondaryEmailsArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<AddSecondaryEmailsResult> | 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 AddSecondaryEmailsError. |
MembersSecondaryEmailsAddAsync(IEnumerable<UserSecondaryEmailsArg>)
Add secondary emails to users.
Permission : Team member management.
Emails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent.
Declaration
public Task<AddSecondaryEmailsResult> MembersSecondaryEmailsAddAsync(IEnumerable<UserSecondaryEmailsArg> newSecondaryEmails)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSecondaryEmailsArg> | newSecondaryEmails | List of users and secondary emails to add. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<AddSecondaryEmailsResult> | 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 AddSecondaryEmailsError. |
MembersSecondaryEmailsDeleteAsync(DeleteSecondaryEmailsArg)
Delete secondary emails from users
Permission : Team member management.
Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email.
Declaration
public Task<DeleteSecondaryEmailsResult> MembersSecondaryEmailsDeleteAsync(DeleteSecondaryEmailsArg deleteSecondaryEmailsArg)
Parameters
Type | Name | Description |
---|---|---|
DeleteSecondaryEmailsArg | deleteSecondaryEmailsArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeleteSecondaryEmailsResult> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersSecondaryEmailsDeleteAsync(IEnumerable<UserSecondaryEmailsArg>)
Delete secondary emails from users
Permission : Team member management.
Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email.
Declaration
public Task<DeleteSecondaryEmailsResult> MembersSecondaryEmailsDeleteAsync(IEnumerable<UserSecondaryEmailsArg> emailsToDelete)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSecondaryEmailsArg> | emailsToDelete | List of users and their secondary emails to delete. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeleteSecondaryEmailsResult> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersSecondaryEmailsResendVerificationEmailsAsync(ResendVerificationEmailArg)
Resend secondary email verification emails.
Permission : Team member management.
Declaration
public Task<ResendVerificationEmailResult> MembersSecondaryEmailsResendVerificationEmailsAsync(ResendVerificationEmailArg resendVerificationEmailArg)
Parameters
Type | Name | Description |
---|---|---|
ResendVerificationEmailArg | resendVerificationEmailArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResendVerificationEmailResult> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersSecondaryEmailsResendVerificationEmailsAsync(IEnumerable<UserSecondaryEmailsArg>)
Resend secondary email verification emails.
Permission : Team member management.
Declaration
public Task<ResendVerificationEmailResult> MembersSecondaryEmailsResendVerificationEmailsAsync(IEnumerable<UserSecondaryEmailsArg> emailsToResend)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<UserSecondaryEmailsArg> | emailsToResend | List of users and secondary emails to resend verification emails to. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResendVerificationEmailResult> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
MembersSendWelcomeEmailAsync(UserSelectorArg)
Sends welcome email to pending team member.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
No-op if team member is not pending.
Declaration
public Task MembersSendWelcomeEmailAsync(UserSelectorArg userSelectorArg)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | userSelectorArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSendWelcomeError. |
MembersSetAdminPermissionsAsync(MembersSetPermissionsArg)
Updates a team member's permissions.
Permission : Team member management.
Declaration
public Task<MembersSetPermissionsResult> MembersSetAdminPermissionsAsync(MembersSetPermissionsArg membersSetPermissionsArg)
Parameters
Type | Name | Description |
---|---|---|
MembersSetPermissionsArg | membersSetPermissionsArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersSetPermissionsResult> | 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 MembersSetPermissionsError. |
MembersSetAdminPermissionsAsync(UserSelectorArg, AdminTier)
Updates a team member's permissions.
Permission : Team member management.
Declaration
public Task<MembersSetPermissionsResult> MembersSetAdminPermissionsAsync(UserSelectorArg user, AdminTier newRole)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user whose role will be set. |
AdminTier | newRole | The new role of the member. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersSetPermissionsResult> | 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 MembersSetPermissionsError. |
MembersSetAdminPermissionsV2Async(MembersSetPermissions2Arg)
Updates a team member's permissions.
Permission : Team member management.
Declaration
public Task<MembersSetPermissions2Result> MembersSetAdminPermissionsV2Async(MembersSetPermissions2Arg membersSetPermissions2Arg)
Parameters
Type | Name | Description |
---|---|---|
MembersSetPermissions2Arg | membersSetPermissions2Arg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersSetPermissions2Result> | 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 MembersSetPermissions2Error. |
MembersSetAdminPermissionsV2Async(UserSelectorArg, IEnumerable<String>)
Updates a team member's permissions.
Permission : Team member management.
Declaration
public Task<MembersSetPermissions2Result> MembersSetAdminPermissionsV2Async(UserSelectorArg user, IEnumerable<string> newRoles = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user whose role will be set. |
System.Collections.Generic.IEnumerable<System.String> | newRoles | The new roles for the member. Send empty list to make user member only. For now, only up to one role is allowed. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<MembersSetPermissions2Result> | 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 MembersSetPermissions2Error. |
MembersSetProfileAsync(MembersSetProfileArg)
Updates a team member's profile.
Permission : Team member management.
Declaration
public Task<TeamMemberInfo> MembersSetProfileAsync(MembersSetProfileArg membersSetProfileArg)
Parameters
Type | Name | Description |
---|---|---|
MembersSetProfileArg | membersSetProfileArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfo> | 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 MembersSetProfileError. |
MembersSetProfileAsync(UserSelectorArg, String, String, String, String, String, Nullable<Boolean>)
Updates a team member's profile.
Permission : Team member management.
Declaration
public Task<TeamMemberInfo> MembersSetProfileAsync(UserSelectorArg user, string newEmail = null, string newExternalId = null, string newGivenName = null, string newSurname = null, string newPersistentId = null, bool? newIsDirectoryRestricted = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user whose profile will be set. |
System.String | newEmail | New email for member. |
System.String | newExternalId | New external ID for member. |
System.String | newGivenName | New given name for member. |
System.String | newSurname | New surname for member. |
System.String | newPersistentId | New persistent ID. This field only available to teams using persistent ID SAML configuration. |
System.Nullable<System.Boolean> | newIsDirectoryRestricted | New value for whether the user is a directory restricted user. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfo> | 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 MembersSetProfileError. |
MembersSetProfilePhotoAsync(MembersSetProfilePhotoArg)
Updates a team member's profile photo.
Permission : Team member management.
Declaration
public Task<TeamMemberInfo> MembersSetProfilePhotoAsync(MembersSetProfilePhotoArg membersSetProfilePhotoArg)
Parameters
Type | Name | Description |
---|---|---|
MembersSetProfilePhotoArg | membersSetProfilePhotoArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfo> | 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 MembersSetProfilePhotoError. |
MembersSetProfilePhotoAsync(UserSelectorArg, PhotoSourceArg)
Updates a team member's profile photo.
Permission : Team member management.
Declaration
public Task<TeamMemberInfo> MembersSetProfilePhotoAsync(UserSelectorArg user, PhotoSourceArg photo)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of the user whose profile photo will be set. |
PhotoSourceArg | photo | Image to set as the member's new profile photo. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfo> | 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 MembersSetProfilePhotoError. |
MembersSetProfilePhotoV2Async(MembersSetProfilePhotoArg)
Updates a team member's profile photo.
Permission : Team member management.
Declaration
public Task<TeamMemberInfoV2Result> MembersSetProfilePhotoV2Async(MembersSetProfilePhotoArg membersSetProfilePhotoArg)
Parameters
Type | Name | Description |
---|---|---|
MembersSetProfilePhotoArg | membersSetProfilePhotoArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfoV2Result> | 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 MembersSetProfilePhotoError. |
MembersSetProfilePhotoV2Async(UserSelectorArg, PhotoSourceArg)
Updates a team member's profile photo.
Permission : Team member management.
Declaration
public Task<TeamMemberInfoV2Result> MembersSetProfilePhotoV2Async(UserSelectorArg user, PhotoSourceArg photo)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of the user whose profile photo will be set. |
PhotoSourceArg | photo | Image to set as the member's new profile photo. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfoV2Result> | 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 MembersSetProfilePhotoError. |
MembersSetProfileV2Async(MembersSetProfileArg)
Updates a team member's profile.
Permission : Team member management.
Declaration
public Task<TeamMemberInfoV2Result> MembersSetProfileV2Async(MembersSetProfileArg membersSetProfileArg)
Parameters
Type | Name | Description |
---|---|---|
MembersSetProfileArg | membersSetProfileArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfoV2Result> | 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 MembersSetProfileError. |
MembersSetProfileV2Async(UserSelectorArg, String, String, String, String, String, Nullable<Boolean>)
Updates a team member's profile.
Permission : Team member management.
Declaration
public Task<TeamMemberInfoV2Result> MembersSetProfileV2Async(UserSelectorArg user, string newEmail = null, string newExternalId = null, string newGivenName = null, string newSurname = null, string newPersistentId = null, bool? newIsDirectoryRestricted = null)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user whose profile will be set. |
System.String | newEmail | New email for member. |
System.String | newExternalId | New external ID for member. |
System.String | newGivenName | New given name for member. |
System.String | newSurname | New surname for member. |
System.String | newPersistentId | New persistent ID. This field only available to teams using persistent ID SAML configuration. |
System.Nullable<System.Boolean> | newIsDirectoryRestricted | New value for whether the user is a directory restricted user. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamMemberInfoV2Result> | 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 MembersSetProfileError. |
MembersSuspendAsync(MembersDeactivateArg)
Suspend a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Declaration
public Task MembersSuspendAsync(MembersDeactivateArg membersDeactivateArg)
Parameters
Type | Name | Description |
---|---|---|
MembersDeactivateArg | membersDeactivateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSuspendError. |
MembersSuspendAsync(UserSelectorArg, Boolean)
Suspend a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Declaration
public Task MembersSuspendAsync(UserSelectorArg user, bool wipeData = true)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to remove/suspend/have their files moved. |
System.Boolean | wipeData | If provided, controls if the user's data will be deleted on their linked devices. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersSuspendError. |
MembersUnsuspendAsync(MembersUnsuspendArg)
Unsuspend a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Declaration
public Task MembersUnsuspendAsync(MembersUnsuspendArg membersUnsuspendArg)
Parameters
Type | Name | Description |
---|---|---|
MembersUnsuspendArg | membersUnsuspendArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersUnsuspendError. |
MembersUnsuspendAsync(UserSelectorArg)
Unsuspend a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Declaration
public Task MembersUnsuspendAsync(UserSelectorArg user)
Parameters
Type | Name | Description |
---|---|---|
UserSelectorArg | user | Identity of user to unsuspend. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a MembersUnsuspendError. |
NamespacesListAsync(TeamNamespacesListArg)
Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.
Declaration
public Task<TeamNamespacesListResult> NamespacesListAsync(TeamNamespacesListArg teamNamespacesListArg)
Parameters
Type | Name | Description |
---|---|---|
TeamNamespacesListArg | teamNamespacesListArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamNamespacesListResult> | 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 TeamNamespacesListError. |
NamespacesListAsync(UInt32)
Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.
Declaration
public Task<TeamNamespacesListResult> NamespacesListAsync(uint limit = 1000U)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | Specifying a value here has no effect. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamNamespacesListResult> | 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 TeamNamespacesListError. |
NamespacesListContinueAsync(TeamNamespacesListContinueArg)
Once a cursor has been retrieved from NamespacesListAsync(TeamNamespacesListArg), use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.
Declaration
public Task<TeamNamespacesListResult> NamespacesListContinueAsync(TeamNamespacesListContinueArg teamNamespacesListContinueArg)
Parameters
Type | Name | Description |
---|---|---|
TeamNamespacesListContinueArg | teamNamespacesListContinueArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamNamespacesListResult> | 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 TeamNamespacesListContinueError. |
NamespacesListContinueAsync(String)
Once a cursor has been retrieved from NamespacesListAsync(TeamNamespacesListArg), use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.
Declaration
public Task<TeamNamespacesListResult> NamespacesListContinueAsync(string cursor)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of team-accessible namespaces. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamNamespacesListResult> | 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 TeamNamespacesListContinueError. |
PropertiesTemplateAddAsync(AddTemplateArg)
Permission : Team member file access.
Declaration
[Obsolete("This function is deprecated")]
public Task<AddTemplateResult> PropertiesTemplateAddAsync(AddTemplateArg addTemplateArg)
Parameters
Type | Name | Description |
---|---|---|
AddTemplateArg | addTemplateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<AddTemplateResult> | 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 ModifyTemplateError. |
PropertiesTemplateAddAsync(String, String, IEnumerable<PropertyFieldTemplate>)
Permission : Team member file access.
Declaration
[Obsolete("This function is deprecated")]
public Task<AddTemplateResult> PropertiesTemplateAddAsync(string name, string description, IEnumerable<PropertyFieldTemplate> fields)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Display name for the template. Template names can be up to 256 bytes. |
System.String | description | Description for the template. Template descriptions can be up to 1024 bytes. |
System.Collections.Generic.IEnumerable<PropertyFieldTemplate> | fields | Definitions of the property fields associated with this template. There can be up to 32 properties in a single template. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<AddTemplateResult> | 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 ModifyTemplateError. |
PropertiesTemplateGetAsync(GetTemplateArg)
Permission : Team member file access. The scope for the route is files.team_metadata.write.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetTemplateResult> PropertiesTemplateGetAsync(GetTemplateArg getTemplateArg)
Parameters
Type | Name | Description |
---|---|---|
GetTemplateArg | getTemplateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetTemplateResult> | 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 TemplateError. |
PropertiesTemplateGetAsync(String)
Permission : Team member file access. The scope for the route is files.team_metadata.write.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetTemplateResult> PropertiesTemplateGetAsync(string templateId)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | An identifier for template added by route See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg). |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetTemplateResult> | 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 TemplateError. |
PropertiesTemplateListAsync()
Permission : Team member file access. The scope for the route is files.team_metadata.write.
Declaration
[Obsolete("This function is deprecated")]
public Task<ListTemplateResult> PropertiesTemplateListAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ListTemplateResult> | 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 TemplateError. |
PropertiesTemplateUpdateAsync(UpdateTemplateArg)
Permission : Team member file access.
Declaration
[Obsolete("This function is deprecated")]
public Task<UpdateTemplateResult> PropertiesTemplateUpdateAsync(UpdateTemplateArg updateTemplateArg)
Parameters
Type | Name | Description |
---|---|---|
UpdateTemplateArg | updateTemplateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<UpdateTemplateResult> | 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 ModifyTemplateError. |
PropertiesTemplateUpdateAsync(String, String, String, IEnumerable<PropertyFieldTemplate>)
Permission : Team member file access.
Declaration
[Obsolete("This function is deprecated")]
public Task<UpdateTemplateResult> PropertiesTemplateUpdateAsync(string templateId, string name = null, string description = null, IEnumerable<PropertyFieldTemplate> addFields = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | templateId | An identifier for template added by See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg). |
System.String | name | A display name for the template. template names can be up to 256 bytes. |
System.String | description | Description for the new template. Template descriptions can be up to 1024 bytes. |
System.Collections.Generic.IEnumerable<PropertyFieldTemplate> | addFields | Property field templates to be added to the group template. There can be up to 32 properties in a single template. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<UpdateTemplateResult> | 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 ModifyTemplateError. |
ReportsGetActivityAsync(DateRange)
Retrieves reporting data about a team's user activity. Deprecated: Will be removed on July 1st 2021.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetActivityReport> ReportsGetActivityAsync(DateRange dateRange)
Parameters
Type | Name | Description |
---|---|---|
DateRange | dateRange | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetActivityReport> | 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 DateRangeError. |
ReportsGetActivityAsync(Nullable<DateTime>, Nullable<DateTime>)
Retrieves reporting data about a team's user activity. Deprecated: Will be removed on July 1st 2021.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetActivityReport> ReportsGetActivityAsync(DateTime? startDate = null, DateTime? endDate = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.DateTime> | startDate | Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. |
System.Nullable<System.DateTime> | endDate | Optional ending date (exclusive). |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetActivityReport> | 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 DateRangeError. |
ReportsGetDevicesAsync(DateRange)
Retrieves reporting data about a team's linked devices. Deprecated: Will be removed on July 1st 2021.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetDevicesReport> ReportsGetDevicesAsync(DateRange dateRange)
Parameters
Type | Name | Description |
---|---|---|
DateRange | dateRange | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetDevicesReport> | 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 DateRangeError. |
ReportsGetDevicesAsync(Nullable<DateTime>, Nullable<DateTime>)
Retrieves reporting data about a team's linked devices. Deprecated: Will be removed on July 1st 2021.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetDevicesReport> ReportsGetDevicesAsync(DateTime? startDate = null, DateTime? endDate = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.DateTime> | startDate | Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. |
System.Nullable<System.DateTime> | endDate | Optional ending date (exclusive). |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetDevicesReport> | 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 DateRangeError. |
ReportsGetMembershipAsync(DateRange)
Retrieves reporting data about a team's membership. Deprecated: Will be removed on July 1st 2021.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetMembershipReport> ReportsGetMembershipAsync(DateRange dateRange)
Parameters
Type | Name | Description |
---|---|---|
DateRange | dateRange | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetMembershipReport> | 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 DateRangeError. |
ReportsGetMembershipAsync(Nullable<DateTime>, Nullable<DateTime>)
Retrieves reporting data about a team's membership. Deprecated: Will be removed on July 1st 2021.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetMembershipReport> ReportsGetMembershipAsync(DateTime? startDate = null, DateTime? endDate = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.DateTime> | startDate | Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. |
System.Nullable<System.DateTime> | endDate | Optional ending date (exclusive). |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetMembershipReport> | 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 DateRangeError. |
ReportsGetStorageAsync(DateRange)
Retrieves reporting data about a team's storage usage. Deprecated: Will be removed on July 1st 2021.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetStorageReport> ReportsGetStorageAsync(DateRange dateRange)
Parameters
Type | Name | Description |
---|---|---|
DateRange | dateRange | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetStorageReport> | 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 DateRangeError. |
ReportsGetStorageAsync(Nullable<DateTime>, Nullable<DateTime>)
Retrieves reporting data about a team's storage usage. Deprecated: Will be removed on July 1st 2021.
Declaration
[Obsolete("This function is deprecated")]
public Task<GetStorageReport> ReportsGetStorageAsync(DateTime? startDate = null, DateTime? endDate = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<System.DateTime> | startDate | Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. |
System.Nullable<System.DateTime> | endDate | Optional ending date (exclusive). |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetStorageReport> | 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 DateRangeError. |
TeamFolderActivateAsync(TeamFolderIdArg)
Sets an archived team folder's status to active.
Permission : Team member file access.
Declaration
public Task<TeamFolderMetadata> TeamFolderActivateAsync(TeamFolderIdArg teamFolderIdArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderIdArg | teamFolderIdArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderMetadata> | 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 TeamFolderActivateError. |
TeamFolderActivateAsync(String)
Sets an archived team folder's status to active.
Permission : Team member file access.
Declaration
public Task<TeamFolderMetadata> TeamFolderActivateAsync(string teamFolderId)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderMetadata> | 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 TeamFolderActivateError. |
TeamFolderArchiveAsync(TeamFolderArchiveArg)
Sets an active team folder's status to archived and removes all folder and file members. This endpoint cannot be used for teams that have a shared team space.
Permission : Team member file access.
Declaration
public Task<TeamFolderArchiveLaunch> TeamFolderArchiveAsync(TeamFolderArchiveArg teamFolderArchiveArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderArchiveArg | teamFolderArchiveArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderArchiveLaunch> | 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 TeamFolderArchiveError. |
TeamFolderArchiveAsync(String, Boolean)
Sets an active team folder's status to archived and removes all folder and file members. This endpoint cannot be used for teams that have a shared team space.
Permission : Team member file access.
Declaration
public Task<TeamFolderArchiveLaunch> TeamFolderArchiveAsync(string teamFolderId, bool forceAsyncOff = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
System.Boolean | forceAsyncOff | Whether to force the archive to happen synchronously. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderArchiveLaunch> | 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 TeamFolderArchiveError. |
TeamFolderArchiveCheckAsync(PollArg)
Returns the status of an asynchronous job for archiving a team folder.
Permission : Team member file access.
Declaration
public Task<TeamFolderArchiveJobStatus> TeamFolderArchiveCheckAsync(PollArg pollArg)
Parameters
Type | Name | Description |
---|---|---|
PollArg | pollArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderArchiveJobStatus> | 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 PollError. |
TeamFolderArchiveCheckAsync(String)
Returns the status of an asynchronous job for archiving a team folder.
Permission : Team member file access.
Declaration
public Task<TeamFolderArchiveJobStatus> TeamFolderArchiveCheckAsync(string asyncJobId)
Parameters
Type | Name | Description |
---|---|---|
System.String | asyncJobId | Id of the asynchronous job. This is the value of a response returned from the method that launched the job. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderArchiveJobStatus> | 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 PollError. |
TeamFolderCreateAsync(TeamFolderCreateArg)
Creates a new, active, team folder with no members. This endpoint can only be used for teams that do not already have a shared team space.
Permission : Team member file access.
Declaration
public Task<TeamFolderMetadata> TeamFolderCreateAsync(TeamFolderCreateArg teamFolderCreateArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderCreateArg | teamFolderCreateArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderMetadata> | 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 TeamFolderCreateError. |
TeamFolderCreateAsync(String, SyncSettingArg)
Creates a new, active, team folder with no members. This endpoint can only be used for teams that do not already have a shared team space.
Permission : Team member file access.
Declaration
public Task<TeamFolderMetadata> TeamFolderCreateAsync(string name, SyncSettingArg syncSetting = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name for the new team folder. |
SyncSettingArg | syncSetting | The sync setting to apply to this team folder. Only permitted if the team has team selective sync enabled. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderMetadata> | 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 TeamFolderCreateError. |
TeamFolderGetInfoAsync(TeamFolderIdListArg)
Retrieves metadata for team folders.
Permission : Team member file access.
Declaration
public Task<List<TeamFolderGetInfoItem>> TeamFolderGetInfoAsync(TeamFolderIdListArg teamFolderIdListArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderIdListArg | teamFolderIdListArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<TeamFolderGetInfoItem>> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
TeamFolderGetInfoAsync(IEnumerable<String>)
Retrieves metadata for team folders.
Permission : Team member file access.
Declaration
public Task<List<TeamFolderGetInfoItem>> TeamFolderGetInfoAsync(IEnumerable<string> teamFolderIds)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.String> | teamFolderIds | The list of team folder IDs. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.List<TeamFolderGetInfoItem>> | The task that represents the asynchronous send operation. The TResult parameter contains the response from the server. |
TeamFolderListAsync(TeamFolderListArg)
Lists all team folders.
Permission : Team member file access.
Declaration
public Task<TeamFolderListResult> TeamFolderListAsync(TeamFolderListArg teamFolderListArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderListArg | teamFolderListArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderListResult> | 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 TeamFolderListError. |
TeamFolderListAsync(UInt32)
Lists all team folders.
Permission : Team member file access.
Declaration
public Task<TeamFolderListResult> TeamFolderListAsync(uint limit = 1000U)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | limit | The maximum number of results to return per request. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderListResult> | 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 TeamFolderListError. |
TeamFolderListContinueAsync(TeamFolderListContinueArg)
Once a cursor has been retrieved from TeamFolderListAsync(TeamFolderListArg), use this to paginate through all team folders.
Permission : Team member file access.
Declaration
public Task<TeamFolderListResult> TeamFolderListContinueAsync(TeamFolderListContinueArg teamFolderListContinueArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderListContinueArg | teamFolderListContinueArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderListResult> | 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 TeamFolderListContinueError. |
TeamFolderListContinueAsync(String)
Once a cursor has been retrieved from TeamFolderListAsync(TeamFolderListArg), use this to paginate through all team folders.
Permission : Team member file access.
Declaration
public Task<TeamFolderListResult> TeamFolderListContinueAsync(string cursor)
Parameters
Type | Name | Description |
---|---|---|
System.String | cursor | Indicates from what point to get the next set of team folders. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderListResult> | 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 TeamFolderListContinueError. |
TeamFolderPermanentlyDeleteAsync(TeamFolderIdArg)
Permanently deletes an archived team folder. This endpoint cannot be used for teams that have a shared team space.
Permission : Team member file access.
Declaration
public Task TeamFolderPermanentlyDeleteAsync(TeamFolderIdArg teamFolderIdArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderIdArg | teamFolderIdArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderPermanentlyDeleteError. |
TeamFolderPermanentlyDeleteAsync(String)
Permanently deletes an archived team folder. This endpoint cannot be used for teams that have a shared team space.
Permission : Team member file access.
Declaration
public Task TeamFolderPermanentlyDeleteAsync(string teamFolderId)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | The task that represents the asynchronous send operation. |
Exceptions
Type | Condition |
---|---|
ApiException<TError> | Thrown if there is an error processing the request; This will contain a TeamFolderPermanentlyDeleteError. |
TeamFolderRenameAsync(TeamFolderRenameArg)
Changes an active team folder's name.
Permission : Team member file access.
Declaration
public Task<TeamFolderMetadata> TeamFolderRenameAsync(TeamFolderRenameArg teamFolderRenameArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderRenameArg | teamFolderRenameArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderMetadata> | 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 TeamFolderRenameError. |
TeamFolderRenameAsync(String, String)
Changes an active team folder's name.
Permission : Team member file access.
Declaration
public Task<TeamFolderMetadata> TeamFolderRenameAsync(string teamFolderId, string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
System.String | name | New team folder name. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderMetadata> | 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 TeamFolderRenameError. |
TeamFolderUpdateSyncSettingsAsync(TeamFolderUpdateSyncSettingsArg)
Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.
Declaration
public Task<TeamFolderMetadata> TeamFolderUpdateSyncSettingsAsync(TeamFolderUpdateSyncSettingsArg teamFolderUpdateSyncSettingsArg)
Parameters
Type | Name | Description |
---|---|---|
TeamFolderUpdateSyncSettingsArg | teamFolderUpdateSyncSettingsArg | The request parameters |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderMetadata> | 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 TeamFolderUpdateSyncSettingsError. |
TeamFolderUpdateSyncSettingsAsync(String, SyncSettingArg, IEnumerable<ContentSyncSettingArg>)
Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.
Declaration
public Task<TeamFolderMetadata> TeamFolderUpdateSyncSettingsAsync(string teamFolderId, SyncSettingArg syncSetting = null, IEnumerable<ContentSyncSettingArg> contentSyncSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | teamFolderId | The ID of the team folder. |
SyncSettingArg | syncSetting | Sync setting to apply to the team folder itself. Only meaningful if the team folder is not a shared team root. |
System.Collections.Generic.IEnumerable<ContentSyncSettingArg> | contentSyncSettings | Sync settings to apply to contents of this team folder. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TeamFolderMetadata> | 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 TeamFolderUpdateSyncSettingsError. |
TokenGetAuthenticatedAdminAsync()
Returns the member profile of the admin who generated the team access token used to make the call.
Declaration
public Task<TokenGetAuthenticatedAdminResult> TokenGetAuthenticatedAdminAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<TokenGetAuthenticatedAdminResult> | 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 TokenGetAuthenticatedAdminError. |