C# Class ZendeskApi_v2.Requests.Users

Inheritance: Core, IUsers
Afficher le fichier Open project: mozts2005/ZendeskApi_v2 Class Usage Examples

Méthodes publiques

Méthode 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

Méthode Description
GetResourceStringWithSideLoadOptionsParam ( string resource, UserSideLoadOptions sideLoadOptions ) : string

Method Details

AddUserIdentity() public méthode

public AddUserIdentity ( long userId, ZendeskApi_v2.Models.Users.UserIdentity identity ) : ZendeskApi_v2.Models.Users.IndividualUserIdentityResponse
userId long
identity ZendeskApi_v2.Models.Users.UserIdentity
Résultat ZendeskApi_v2.Models.Users.IndividualUserIdentityResponse

AddUserIdentityAsync() public méthode

public AddUserIdentityAsync ( long userId, UserIdentity identity ) : Task
userId long
identity UserIdentity
Résultat Task

BulkCreateUsers() public méthode

public BulkCreateUsers ( IEnumerable users ) : JobStatusResponse
users IEnumerable
Résultat JobStatusResponse

BulkCreateUsersAsync() public méthode

public BulkCreateUsersAsync ( IEnumerable users ) : Task
users IEnumerable
Résultat Task

ChangeUsersPassword() public méthode

public ChangeUsersPassword ( long userId, string oldPassword, string newPassword ) : bool
userId long
oldPassword string
newPassword string
Résultat bool

ChangeUsersPasswordAsync() public méthode

public ChangeUsersPasswordAsync ( long userId, string oldPassword, string newPassword ) : Task
userId long
oldPassword string
newPassword string
Résultat Task

CreateUser() public méthode

public CreateUser ( ZendeskApi_v2.Models.Users.User user ) : IndividualUserResponse
user ZendeskApi_v2.Models.Users.User
Résultat IndividualUserResponse

CreateUserAsync() public méthode

public CreateUserAsync ( ZendeskApi_v2.Models.Users.User user ) : Task
user ZendeskApi_v2.Models.Users.User
Résultat Task

DeleteUser() public méthode

public DeleteUser ( long id ) : bool
id long
Résultat bool

DeleteUserAsync() public méthode

public DeleteUserAsync ( long id ) : Task
id long
Résultat Task

DeleteUserIdentity() public méthode

public DeleteUserIdentity ( long userId, long identityId ) : bool
userId long
identityId long
Résultat bool

DeleteUserIdentityAsync() public méthode

public DeleteUserIdentityAsync ( long userId, long identityId ) : Task
userId long
identityId long
Résultat Task

GetAllUsers() public méthode

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

GetAllUsersAsync() public méthode

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

GetCurrentUser() public méthode

public GetCurrentUser ( ) : IndividualUserResponse
Résultat IndividualUserResponse

GetCurrentUserAsync() public méthode

public GetCurrentUserAsync ( ) : Task
Résultat Task

GetMultipleUsers() public méthode

public GetMultipleUsers ( IEnumerable ids, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : GroupUserResponse
ids IEnumerable
sideLoadOptions UserSideLoadOptions
Résultat GroupUserResponse

GetMultipleUsersAsync() public méthode

public GetMultipleUsersAsync ( IEnumerable ids, UserSideLoadOptions sideLoadOptions = UserSideLoadOptions.None ) : Task
ids IEnumerable
sideLoadOptions UserSideLoadOptions
Résultat Task

GetSpecificUserIdentity() public méthode

public GetSpecificUserIdentity ( long userId, long identityId ) : IndividualUserIdentityResponse
userId long
identityId long
Résultat IndividualUserIdentityResponse

GetSpecificUserIdentityAsync() public méthode

public GetSpecificUserIdentityAsync ( long userId, long identityId ) : Task
userId long
identityId long
Résultat Task

GetUser() public méthode

public GetUser ( long id ) : IndividualUserResponse
id long
Résultat IndividualUserResponse

GetUserAsync() public méthode

public GetUserAsync ( long id ) : Task
id long
Résultat Task

GetUserIdentities() public méthode

public GetUserIdentities ( long userId ) : GroupUserIdentityResponse
userId long
Résultat GroupUserIdentityResponse

GetUserIdentitiesAsync() public méthode

public GetUserIdentitiesAsync ( long userId ) : Task
userId long
Résultat Task

GetUserRelatedInformation() public méthode

public GetUserRelatedInformation ( long id ) : IndividualUserRelatedInformationResponse
id long
Résultat IndividualUserRelatedInformationResponse

GetUserRelatedInformationAsync() public méthode

public GetUserRelatedInformationAsync ( long id ) : Task
id long
Résultat Task

GetUsersInGroup() public méthode

public GetUsersInGroup ( long id ) : GroupUserResponse
id long
Résultat GroupUserResponse

GetUsersInGroupAsync() public méthode

public GetUsersInGroupAsync ( long id ) : Task
id long
Résultat Task

GetUsersInOrganization() public méthode

public GetUsersInOrganization ( long id ) : GroupUserResponse
id long
Résultat GroupUserResponse

GetUsersInOrganizationAsync() public méthode

public GetUsersInOrganizationAsync ( long id ) : Task
id long
Résultat Task

MergeUser() public méthode

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
Résultat IndividualUserResponse

MergeUserAsync() public méthode

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
Résultat Task

SearchByCustomUserField() public méthode

public SearchByCustomUserField ( string fieldKey, string fieldValue ) : GroupUserResponse
fieldKey string
fieldValue string
Résultat GroupUserResponse

SearchByCustomUserFieldAsync() public méthode

public SearchByCustomUserFieldAsync ( string fieldKey, string fieldValue ) : Task
fieldKey string
fieldValue string
Résultat Task

SearchByEmail() public méthode

public SearchByEmail ( string email ) : GroupUserResponse
email string
Résultat GroupUserResponse

SearchByEmailAsync() public méthode

public SearchByEmailAsync ( string email ) : Task
email string
Résultat Task

SearchByExternalId() public méthode

public SearchByExternalId ( string externalId ) : GroupUserResponse
externalId string
Résultat GroupUserResponse

SearchByExternalIdAsync() public méthode

public SearchByExternalIdAsync ( string externalId ) : Task
externalId string
Résultat Task

SearchByPhone() public méthode

public SearchByPhone ( string phone ) : GroupUserResponse
phone string
Résultat GroupUserResponse

SearchByPhoneAsync() public méthode

public SearchByPhoneAsync ( string phone ) : Task
phone string
Résultat Task

SendUserVerificationRequest() public méthode

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
Résultat IndividualUserIdentityResponse

SendUserVerificationRequestAsync() public méthode

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
Résultat Task

SetUserIdentityAsPrimary() public méthode

public SetUserIdentityAsPrimary ( long userId, long identityId ) : GroupUserIdentityResponse
userId long
identityId long
Résultat GroupUserIdentityResponse

SetUserIdentityAsPrimaryAsync() public méthode

public SetUserIdentityAsPrimaryAsync ( long userId, long identityId ) : Task
userId long
identityId long
Résultat Task

SetUserIdentityAsVerified() public méthode

public SetUserIdentityAsVerified ( long userId, long identityId ) : IndividualUserIdentityResponse
userId long
identityId long
Résultat IndividualUserIdentityResponse

SetUserIdentityAsVerifiedAsync() public méthode

public SetUserIdentityAsVerifiedAsync ( long userId, long identityId ) : Task
userId long
identityId long
Résultat Task

SetUserPhoto() public méthode

public SetUserPhoto ( long userId, ZenFile photo ) : IndividualUserResponse
userId long
photo ZenFile
Résultat IndividualUserResponse

SetUserPhotoAsync() public méthode

public SetUserPhotoAsync ( long userId, ZenFile photo ) : Task
userId long
photo ZenFile
Résultat Task

SetUsersPassword() public méthode

public SetUsersPassword ( long userId, string newPassword ) : bool
userId long
newPassword string
Résultat bool

SetUsersPasswordAsync() public méthode

public SetUsersPasswordAsync ( long userId, string newPassword ) : Task
userId long
newPassword string
Résultat Task

SuspendUser() public méthode

public SuspendUser ( long id ) : IndividualUserResponse
id long
Résultat IndividualUserResponse

SuspendUserAsync() public méthode

public SuspendUserAsync ( long id ) : Task
id long
Résultat Task

UpdateUser() public méthode

public UpdateUser ( ZendeskApi_v2.Models.Users.User user ) : IndividualUserResponse
user ZendeskApi_v2.Models.Users.User
Résultat IndividualUserResponse

UpdateUserAsync() public méthode

public UpdateUserAsync ( ZendeskApi_v2.Models.Users.User user ) : Task
user ZendeskApi_v2.Models.Users.User
Résultat Task

UpdateUserIdentity() public méthode

public UpdateUserIdentity ( long userId, UserIdentity identity ) : IndividualUserIdentityResponse
userId long
identity UserIdentity
Résultat IndividualUserIdentityResponse

UpdateUserIdentityAsync() public méthode

public UpdateUserIdentityAsync ( long userId, UserIdentity identity ) : Task
userId long
identity UserIdentity
Résultat Task

Users() public méthode

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
Résultat System