C# Class GriklyApi.GriklyClient

The grikly api.
Inheritance: IGriklyClient
显示文件 Open project: Xormis/grikly-dotnet Class Usage Examples

Public Methods

Method Description
ChangePassword ( string oldPassword, string newPassword, CancellationToken token ) : Task

Changes the password.

ConfirmEmail ( string email, string code, CancellationToken token ) : Task

Confirms the specified email.

CreateCard ( Card card, CancellationToken token ) : Task>

Creates the card.

CreateContact ( Contact contact, CancellationToken token ) : Task>

Creates the contact.

CreateEvent ( EventModel eventModel, CancellationToken token ) : Task>

Creates the event.

CreateOrganisation ( OrganisationModel organisationModel, CancellationToken token ) : Task>

Creates the organisation.

DeleteCard ( System.Guid id, CancellationToken token ) : Task>

Deletes the card.

DeleteContact ( System.Guid id, CancellationToken token ) : Task>

Deletes the contact.

EmailExist ( string email, CancellationToken token ) : Task>

Emails the exist.

GetCard ( System.Guid id, CancellationToken token ) : Task>

Gets the card.

GetContacts ( string searchText, int page, int pageSize, CancellationToken token ) : Task>>

The get contacts.

GetCurrentUserInfo ( CancellationToken token ) : Task>

Get the currently logged in user.

GetEventById ( System.Guid id, CancellationToken token ) : Task>

Gets the event by identifier.

GetOwnedEvents ( GetEventsRequest request, CancellationToken token ) : Task>>

GetUser ( System.Guid id, CancellationToken token ) : Task>

Gets the user.

IsCredentialsSet ( ) : bool

Determines whether [is credentials set].

IsUserConfirmed ( CancellationToken token ) : Task>

Determines whether the currently logged in user has confirmed their email.

Login ( string email, string password, CancellationToken token ) : Task>

Logins the specified email.

Recover ( string email, CancellationToken token ) : Task

Recovers the specified email.

Register ( RegisterModel register, CancellationToken token ) : Task

Registers the specified register.

ResendConfirmation ( string email, CancellationToken token ) : Task

Resends the confirmation.

ResetPassword ( string email, string code, string password, string confirmPassword, CancellationToken token ) : Task

Resets the password.

SendCard ( System.Guid id, SendCardModel model, CancellationToken token ) : Task>

Sends the card.

UpdateCard ( Card card, CancellationToken token ) : Task>

Updates the card.

UpdateContact ( Contact contact, CancellationToken token ) : Task>

Updates the contact.

UpdateEvent ( System.Guid id, EventModel eventModel, CancellationToken token ) : Task

Updates the event.

UploadProfileImage ( byte data, CancellationToken token ) : Task>

Uploads the profile image.

Method Details

ChangePassword() public method

Changes the password.
public ChangePassword ( string oldPassword, string newPassword, CancellationToken token ) : Task
oldPassword string The old password.
newPassword string The new password.
token System.Threading.CancellationToken The token.
return Task

ConfirmEmail() public method

Confirms the specified email.
public ConfirmEmail ( string email, string code, CancellationToken token ) : Task
email string The email.
code string The code.
token System.Threading.CancellationToken The token.
return Task

CreateCard() public method

Creates the card.
public CreateCard ( Card card, CancellationToken token ) : Task>
card GriklyApi.Models.Card /// The card. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

CreateContact() public method

Creates the contact.
public CreateContact ( Contact contact, CancellationToken token ) : Task>
contact GriklyApi.Models.Contact /// The contact. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

CreateEvent() public method

Creates the event.
public CreateEvent ( EventModel eventModel, CancellationToken token ) : Task>
eventModel EventModel The event model.
token System.Threading.CancellationToken The token.
return Task>

CreateOrganisation() public method

Creates the organisation.
public CreateOrganisation ( OrganisationModel organisationModel, CancellationToken token ) : Task>
organisationModel OrganisationModel The organisation model.
token System.Threading.CancellationToken The token.
return Task>

DeleteCard() public method

Deletes the card.
public DeleteCard ( System.Guid id, CancellationToken token ) : Task>
id System.Guid /// The id. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

DeleteContact() public method

Deletes the contact.
public DeleteContact ( System.Guid id, CancellationToken token ) : Task>
id System.Guid /// The id. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

EmailExist() public method

Emails the exist.
public EmailExist ( string email, CancellationToken token ) : Task>
email string The email.
token System.Threading.CancellationToken The token.
return Task>

GetCard() public method

Gets the card.
public GetCard ( System.Guid id, CancellationToken token ) : Task>
id System.Guid /// The id. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

GetContacts() public method

The get contacts.
public GetContacts ( string searchText, int page, int pageSize, CancellationToken token ) : Task>>
searchText string /// The search text. ///
page int /// The page. ///
pageSize int /// The page size. ///
token System.Threading.CancellationToken /// The token. ///
return Task>>

GetCurrentUserInfo() public method

Get the currently logged in user.
public GetCurrentUserInfo ( CancellationToken token ) : Task>
token System.Threading.CancellationToken The token.
return Task>

GetEventById() public method

Gets the event by identifier.
public GetEventById ( System.Guid id, CancellationToken token ) : Task>
id System.Guid The identifier.
token System.Threading.CancellationToken The token.
return Task>

GetOwnedEvents() public method

public GetOwnedEvents ( GetEventsRequest request, CancellationToken token ) : Task>>
request GetEventsRequest
token System.Threading.CancellationToken
return Task>>

GetUser() public method

Gets the user.
public GetUser ( System.Guid id, CancellationToken token ) : Task>
id System.Guid /// The id. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

IsCredentialsSet() public method

Determines whether [is credentials set].
public IsCredentialsSet ( ) : bool
return bool

IsUserConfirmed() public method

Determines whether the currently logged in user has confirmed their email.
public IsUserConfirmed ( CancellationToken token ) : Task>
token System.Threading.CancellationToken The token.
return Task>

Login() public method

Logins the specified email.
public Login ( string email, string password, CancellationToken token ) : Task>
email string The email.
password string The password.
token System.Threading.CancellationToken The token.
return Task>

Recover() public method

Recovers the specified email.
public Recover ( string email, CancellationToken token ) : Task
email string The email.
token System.Threading.CancellationToken The token.
return Task

Register() public method

Registers the specified register.
public Register ( RegisterModel register, CancellationToken token ) : Task
register GriklyApi.Models.RegisterModel The register.
token System.Threading.CancellationToken The token.
return Task

ResendConfirmation() public method

Resends the confirmation.
public ResendConfirmation ( string email, CancellationToken token ) : Task
email string The email.
token System.Threading.CancellationToken The token.
return Task

ResetPassword() public method

Resets the password.
public ResetPassword ( string email, string code, string password, string confirmPassword, CancellationToken token ) : Task
email string The email.
code string The code.
password string The password.
confirmPassword string The confirm password.
token System.Threading.CancellationToken The token.
return Task

SendCard() public method

Sends the card.
public SendCard ( System.Guid id, SendCardModel model, CancellationToken token ) : Task>
id System.Guid /// The id. ///
model GriklyApi.Models.SendCardModel /// The model. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

UpdateCard() public method

Updates the card.
public UpdateCard ( Card card, CancellationToken token ) : Task>
card GriklyApi.Models.Card /// The card. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

UpdateContact() public method

Updates the contact.
public UpdateContact ( Contact contact, CancellationToken token ) : Task>
contact GriklyApi.Models.Contact /// The contact. ///
token System.Threading.CancellationToken /// The token. ///
return Task>

UpdateEvent() public method

Updates the event.
public UpdateEvent ( System.Guid id, EventModel eventModel, CancellationToken token ) : Task
id System.Guid The identifier.
eventModel EventModel The event model.
token System.Threading.CancellationToken The token.
return Task

UploadProfileImage() public method

Uploads the profile image.
public UploadProfileImage ( byte data, CancellationToken token ) : Task>
data byte The data.
token System.Threading.CancellationToken The token.
return Task>