C# Class ZendeskApi_v2.Requests.Users

Inheritance: Core, IUsers

Show file Open project: mozts2005/ZendeskApi_v2 Class Usage Examples

Public Methods

Method	Description
AddUserIdentity ( long userId, ZendeskApi_v2.Models.Users.UserIdentity identity ) : ZendeskApi_v2.Models.Users.IndividualUserIdentityResponse
AddUserIdentityAsync ( long userId, UserIdentity identity ) : Task
BulkCreateUsers ( IEnumerable users ) : JobStatusResponse
BulkCreateUsersAsync ( IEnumerable users ) : Task
ChangeUsersPassword ( long userId, string oldPassword, string newPassword ) : bool
ChangeUsersPasswordAsync ( long userId, string oldPassword, string newPassword ) : Task
CreateUser ( ZendeskApi_v2.Models.Users.User user ) : IndividualUserResponse
CreateUserAsync ( ZendeskApi_v2.Models.Users.User user ) : Task
DeleteUser ( long id ) : bool
DeleteUserAsync ( long id ) : Task
DeleteUserIdentity ( long userId, long identityId ) : bool
DeleteUserIdentityAsync ( long userId, long identityId ) : Task
GetAllUsers ( int perPage = null, int page = null, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : GroupUserResponse
GetAllUsersAsync ( int perPage = null, int page = null, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : Task
GetCurrentUser ( ) : IndividualUserResponse
GetCurrentUserAsync ( ) : Task
GetMultipleUsers ( IEnumerable ids, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : GroupUserResponse
GetMultipleUsersAsync ( IEnumerable ids, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : Task
GetSpecificUserIdentity ( long userId, long identityId ) : IndividualUserIdentityResponse
GetSpecificUserIdentityAsync ( long userId, long identityId ) : Task
GetUser ( long id ) : IndividualUserResponse
GetUserAsync ( long id ) : Task
GetUserIdentities ( long userId ) : GroupUserIdentityResponse
GetUserIdentitiesAsync ( long userId ) : Task
GetUserRelatedInformation ( long id ) : IndividualUserRelatedInformationResponse
GetUserRelatedInformationAsync ( long id ) : Task
GetUsersInGroup ( long id ) : GroupUserResponse
GetUsersInGroupAsync ( long id ) : Task
GetUsersInOrganization ( long id ) : GroupUserResponse
GetUsersInOrganizationAsync ( long id ) : Task
MergeUser ( long fromId, long intoId ) : IndividualUserResponse	The user whose id is provided in the URL will be merged into the existing user provided in the params. Any two arbitrary users can be merged.
MergeUserAsync ( long fromId, long intoId ) : Task	The user whose id is provided in the URL will be merged into the existing user provided in the params. Any two arbitrary users can be merged.
SearchByCustomUserField ( string fieldKey, string fieldValue ) : GroupUserResponse
SearchByCustomUserFieldAsync ( string fieldKey, string fieldValue ) : Task
SearchByEmail ( string email ) : GroupUserResponse
SearchByEmailAsync ( string email ) : Task
SearchByExternalId ( string externalId ) : GroupUserResponse
SearchByExternalIdAsync ( string externalId ) : Task
SearchByPhone ( string phone ) : GroupUserResponse
SearchByPhoneAsync ( string phone ) : Task
SendUserVerificationRequest ( long userId, long identityId ) : IndividualUserIdentityResponse	This sends a verification email to the user, asking him to click a link in order to verify ownership of the email address
SendUserVerificationRequestAsync ( long userId, long identityId ) : Task	This sends a verification email to the user, asking him to click a link in order to verify ownership of the email address
SetUserIdentityAsPrimary ( long userId, long identityId ) : GroupUserIdentityResponse
SetUserIdentityAsPrimaryAsync ( long userId, long identityId ) : Task
SetUserIdentityAsVerified ( long userId, long identityId ) : IndividualUserIdentityResponse
SetUserIdentityAsVerifiedAsync ( long userId, long identityId ) : Task
SetUserPhoto ( long userId, ZenFile photo ) : IndividualUserResponse
SetUserPhotoAsync ( long userId, ZenFile photo ) : Task
SetUsersPassword ( long userId, string newPassword ) : bool
SetUsersPasswordAsync ( long userId, string newPassword ) : Task
SuspendUser ( long id ) : IndividualUserResponse
SuspendUserAsync ( long id ) : Task
UpdateUser ( ZendeskApi_v2.Models.Users.User user ) : IndividualUserResponse
UpdateUserAsync ( ZendeskApi_v2.Models.Users.User user ) : Task
UpdateUserIdentity ( long userId, UserIdentity identity ) : IndividualUserIdentityResponse
UpdateUserIdentityAsync ( long userId, UserIdentity identity ) : Task
Users ( string yourZendeskUrl, string user, string password, string apiToken, string p_OAuthToken ) : System

Private Methods

Method	Description
GetResourceStringWithSideLoadOptionsParam ( string resource, UserSideLoadOptions sideLoadOptions ) : string

Method Details

AddUserIdentity() public method

public AddUserIdentity ( long userId, ZendeskApi_v2.Models.Users.UserIdentity identity ) : ZendeskApi_v2.Models.Users.IndividualUserIdentityResponse
userId	long
identity	ZendeskApi_v2.Models.Users.UserIdentity
return	ZendeskApi_v2.Models.Users.IndividualUserIdentityResponse

AddUserIdentityAsync() public method

public AddUserIdentityAsync ( long userId, UserIdentity identity ) : Task
userId	long
identity	UserIdentity
return	Task

BulkCreateUsers() public method

public BulkCreateUsers ( IEnumerable users ) : JobStatusResponse
users	IEnumerable
return	JobStatusResponse

BulkCreateUsersAsync() public method

public BulkCreateUsersAsync ( IEnumerable users ) : Task
users	IEnumerable
return	Task

ChangeUsersPassword() public method

public ChangeUsersPassword ( long userId, string oldPassword, string newPassword ) : bool
userId	long
oldPassword	string
newPassword	string
return	bool

ChangeUsersPasswordAsync() public method

public ChangeUsersPasswordAsync ( long userId, string oldPassword, string newPassword ) : Task
userId	long
oldPassword	string
newPassword	string
return	Task

CreateUser() public method

public CreateUser ( ZendeskApi_v2.Models.Users.User user ) : IndividualUserResponse
user	ZendeskApi_v2.Models.Users.User
return	IndividualUserResponse

CreateUserAsync() public method

public CreateUserAsync ( ZendeskApi_v2.Models.Users.User user ) : Task
user	ZendeskApi_v2.Models.Users.User
return	Task

DeleteUser() public method

public DeleteUser ( long id ) : bool
id	long
return	bool

DeleteUserAsync() public method

public DeleteUserAsync ( long id ) : Task
id	long
return	Task

DeleteUserIdentity() public method

public DeleteUserIdentity ( long userId, long identityId ) : bool
userId	long
identityId	long
return	bool

DeleteUserIdentityAsync() public method

public DeleteUserIdentityAsync ( long userId, long identityId ) : Task
userId	long
identityId	long
return	Task

GetAllUsers() public method

public GetAllUsers ( int perPage = null, int page = null, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : GroupUserResponse
perPage	int
page	int
sideLoadOptions	UserSideLoadOptions
return	GroupUserResponse

GetAllUsersAsync() public method

public GetAllUsersAsync ( int perPage = null, int page = null, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : Task
perPage	int
page	int
sideLoadOptions	UserSideLoadOptions
return	Task

GetCurrentUser() public method

public GetCurrentUser ( ) : IndividualUserResponse
return	IndividualUserResponse

GetCurrentUserAsync() public method

public GetCurrentUserAsync ( ) : Task
return	Task

GetMultipleUsers() public method

public GetMultipleUsers ( IEnumerable ids, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : GroupUserResponse
ids	IEnumerable
sideLoadOptions	UserSideLoadOptions
return	GroupUserResponse

GetMultipleUsersAsync() public method

public GetMultipleUsersAsync ( IEnumerable ids, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : Task
ids	IEnumerable
sideLoadOptions	UserSideLoadOptions
return	Task

GetSpecificUserIdentity() public method

public GetSpecificUserIdentity ( long userId, long identityId ) : IndividualUserIdentityResponse
userId	long
identityId	long
return	IndividualUserIdentityResponse

GetSpecificUserIdentityAsync() public method

public GetSpecificUserIdentityAsync ( long userId, long identityId ) : Task
userId	long
identityId	long
return	Task

GetUser() public method

public GetUser ( long id ) : IndividualUserResponse
id	long
return	IndividualUserResponse

GetUserAsync() public method

public GetUserAsync ( long id ) : Task
id	long
return	Task

GetUserIdentities() public method

public GetUserIdentities ( long userId ) : GroupUserIdentityResponse
userId	long
return	GroupUserIdentityResponse

GetUserIdentitiesAsync() public method

public GetUserIdentitiesAsync ( long userId ) : Task
userId	long
return	Task

GetUserRelatedInformation() public method

public GetUserRelatedInformation ( long id ) : IndividualUserRelatedInformationResponse
id	long
return	IndividualUserRelatedInformationResponse

GetUserRelatedInformationAsync() public method

public GetUserRelatedInformationAsync ( long id ) : Task
id	long
return	Task

GetUsersInGroup() public method

public GetUsersInGroup ( long id ) : GroupUserResponse
id	long
return	GroupUserResponse

GetUsersInGroupAsync() public method

public GetUsersInGroupAsync ( long id ) : Task
id	long
return	Task

GetUsersInOrganization() public method

public GetUsersInOrganization ( long id ) : GroupUserResponse
id	long
return	GroupUserResponse

GetUsersInOrganizationAsync() public method

public GetUsersInOrganizationAsync ( long id ) : Task
id	long
return	Task

MergeUser() public method

The user whose id is provided in the URL will be merged into the existing user provided in the params. Any two arbitrary users can be merged.

public MergeUser ( long fromId, long intoId ) : IndividualUserResponse
fromId	long
intoId	long
return	IndividualUserResponse

MergeUserAsync() public method

The user whose id is provided in the URL will be merged into the existing user provided in the params. Any two arbitrary users can be merged.

public MergeUserAsync ( long fromId, long intoId ) : Task
fromId	long
intoId	long
return	Task

SearchByCustomUserField() public method

public SearchByCustomUserField ( string fieldKey, string fieldValue ) : GroupUserResponse
fieldKey	string
fieldValue	string
return	GroupUserResponse

SearchByCustomUserFieldAsync() public method

public SearchByCustomUserFieldAsync ( string fieldKey, string fieldValue ) : Task
fieldKey	string
fieldValue	string
return	Task

SearchByEmail() public method

public SearchByEmail ( string email ) : GroupUserResponse
email	string
return	GroupUserResponse

SearchByEmailAsync() public method

public SearchByEmailAsync ( string email ) : Task
email	string
return	Task

SearchByExternalId() public method

public SearchByExternalId ( string externalId ) : GroupUserResponse
externalId	string
return	GroupUserResponse

SearchByExternalIdAsync() public method

public SearchByExternalIdAsync ( string externalId ) : Task
externalId	string
return	Task

SearchByPhone() public method

public SearchByPhone ( string phone ) : GroupUserResponse
phone	string
return	GroupUserResponse

SearchByPhoneAsync() public method

public SearchByPhoneAsync ( string phone ) : Task
phone	string
return	Task

SendUserVerificationRequest() public method

This sends a verification email to the user, asking him to click a link in order to verify ownership of the email address

public SendUserVerificationRequest ( long userId, long identityId ) : IndividualUserIdentityResponse
userId	long
identityId	long
return	IndividualUserIdentityResponse

SendUserVerificationRequestAsync() public method

This sends a verification email to the user, asking him to click a link in order to verify ownership of the email address

public SendUserVerificationRequestAsync ( long userId, long identityId ) : Task
userId	long
identityId	long
return	Task

SetUserIdentityAsPrimary() public method

public SetUserIdentityAsPrimary ( long userId, long identityId ) : GroupUserIdentityResponse
userId	long
identityId	long
return	GroupUserIdentityResponse

SetUserIdentityAsPrimaryAsync() public method

public SetUserIdentityAsPrimaryAsync ( long userId, long identityId ) : Task
userId	long
identityId	long
return	Task

SetUserIdentityAsVerified() public method

public SetUserIdentityAsVerified ( long userId, long identityId ) : IndividualUserIdentityResponse
userId	long
identityId	long
return	IndividualUserIdentityResponse

SetUserIdentityAsVerifiedAsync() public method

public SetUserIdentityAsVerifiedAsync ( long userId, long identityId ) : Task
userId	long
identityId	long
return	Task

SetUserPhoto() public method

public SetUserPhoto ( long userId, ZenFile photo ) : IndividualUserResponse
userId	long
photo	ZenFile
return	IndividualUserResponse

SetUserPhotoAsync() public method

public SetUserPhotoAsync ( long userId, ZenFile photo ) : Task
userId	long
photo	ZenFile
return	Task

SetUsersPassword() public method

public SetUsersPassword ( long userId, string newPassword ) : bool
userId	long
newPassword	string
return	bool

SetUsersPasswordAsync() public method

public SetUsersPasswordAsync ( long userId, string newPassword ) : Task
userId	long
newPassword	string
return	Task

SuspendUser() public method

public SuspendUser ( long id ) : IndividualUserResponse
id	long
return	IndividualUserResponse

SuspendUserAsync() public method

public SuspendUserAsync ( long id ) : Task
id	long
return	Task

UpdateUser() public method

public UpdateUser ( ZendeskApi_v2.Models.Users.User user ) : IndividualUserResponse
user	ZendeskApi_v2.Models.Users.User
return	IndividualUserResponse

UpdateUserAsync() public method

public UpdateUserAsync ( ZendeskApi_v2.Models.Users.User user ) : Task
user	ZendeskApi_v2.Models.Users.User
return	Task

UpdateUserIdentity() public method

public UpdateUserIdentity ( long userId, UserIdentity identity ) : IndividualUserIdentityResponse
userId	long
identity	UserIdentity
return	IndividualUserIdentityResponse

UpdateUserIdentityAsync() public method

public UpdateUserIdentityAsync ( long userId, UserIdentity identity ) : Task
userId	long
identity	UserIdentity
return	Task

Users() public method

public Users ( string yourZendeskUrl, string user, string password, string apiToken, string p_OAuthToken ) : System
yourZendeskUrl	string
user	string
password	string
apiToken	string
p_OAuthToken	string
return	System