C# Class PodioAPI.Services.UserService

Mostra file Open project: podio/podio-dotnet

Public Methods

Method	Description
DeleteUserProperty ( string name ) : Task	Deletes the property for the active user with the given name. The property is specific to the auth client used. Podio API Reference: https://developers.podio.com/doc/users/delete-user-property-29800
GetNotificationSetting ( string clientType, string notificationType ) : Task	Get's the setting for the given client type and notification type. Podio API Reference: https://developers.podio.com/doc/users/get-notification-setting-3649859
GetNotificationSettings ( string clientType ) : bool>>.Task	Get's the setting for the given client type and notification type. Podio API Reference: https://developers.podio.com/doc/users/get-notification-setting-3649859
GetProfileField ( string key ) : Task>	Returns the field of the profile for the given key from the active user. For a list of valid keys and their possible values, see the contact area. Podio API Reference: https://developers.podio.com/doc/users/get-profile-field-22380
GetUser ( ) : Task	Gets the active user. Podio API Reference: https://developers.podio.com/doc/users/get-user-22378
GetUserProperty ( string name ) : Task	Returns the value of the property for the active user with the given name. The property is specific to the auth client used. Podio API Reference: https://developers.podio.com/doc/users/get-user-property-29798
GetUserStatus ( ) : Task	Returns the current status for the user. This includes the user data, profile data and notification data. Podio API Reference: https://developers.podio.com/doc/users/get-user-status-22480
SetUserProperties ( object>.Dictionary properties ) : Task	Sets the values of one or more properties for the active user. The properties are specific to the auth client used. Podio API Reference: https://developers.podio.com/doc/users/set-user-properties-9052829
SetUserProperty ( string name, dynamic value ) : Task	Sets the value of the property for the active user with the given name. The property is specific to the auth client used. Podio API Reference: https://developers.podio.com/doc/users/set-user-property-29799
UpdateNotificationSetting ( string clientType, string notificationType, bool value ) : Task	Updates the setting for the given client type and notification type. Podio API Reference: https://developers.podio.com/doc/users/update-notification-setting-3649918
UpdateNotificationSettings ( string clientType, bool>.Dictionary notificationTypes ) : Task	Updates the setting for the given client type Podio API Reference: https://developers.podio.com/doc/users/update-notification-settings-3649927
UpdateProfile ( Contact updatedProfile ) : Task	Updates the fields of an existing profile. Fields not specified will not be updated. To delete a field set the value of the field to null. Podio API Reference: https://developers.podio.com/doc/users/update-profile-22402
UpdateProfileField ( string key, string value ) : Task	Updates the specific field on the user. Podio API Reference: https://developers.podio.com/doc/users/update-profile-field-22500
UserService ( Podio currentInstance ) : System.Collections.Generic

Method Details

DeleteUserProperty() public method

Deletes the property for the active user with the given name. The property is specific to the auth client used.

Podio API Reference: https://developers.podio.com/doc/users/delete-user-property-29800

public DeleteUserProperty ( string name ) : Task
name	string
return	Task

GetNotificationSetting() public method

Get's the setting for the given client type and notification type.

Podio API Reference: https://developers.podio.com/doc/users/get-notification-setting-3649859

public GetNotificationSetting ( string clientType, string notificationType ) : Task
clientType	string	Client type: "email" and "mobile".
notificationType	string	/// Notification type: "digest", "bulletin", "reference", "message", "space", /// "subscription", "user", "reminder", "push_notification", "push_notification_sound" or "push_notification_browser". ///
return	Task

GetNotificationSettings() public method

Get's the setting for the given client type and notification type.

Podio API Reference: https://developers.podio.com/doc/users/get-notification-setting-3649859

public GetNotificationSettings ( string clientType ) : bool>>.Task
clientType	string	Client type: "email" and "mobile".
return	bool>>.Task

GetProfileField() public method

Returns the field of the profile for the given key from the active user. For a list of valid keys and their possible values, see the contact area.

Podio API Reference: https://developers.podio.com/doc/users/get-profile-field-22380

public GetProfileField ( string key ) : Task>
key	string
return	Task>

GetUser() public method

Gets the active user.

Podio API Reference: https://developers.podio.com/doc/users/get-user-22378

public GetUser ( ) : Task
return	Task

GetUserProperty() public method

Returns the value of the property for the active user with the given name. The property is specific to the auth client used.

Podio API Reference: https://developers.podio.com/doc/users/get-user-property-29798

public GetUserProperty ( string name ) : Task
name	string
return	Task

GetUserStatus() public method

Returns the current status for the user. This includes the user data, profile data and notification data.

Podio API Reference: https://developers.podio.com/doc/users/get-user-status-22480

public GetUserStatus ( ) : Task
return	Task

SetUserProperties() public method

Sets the values of one or more properties for the active user. The properties are specific to the auth client used.

Podio API Reference: https://developers.podio.com/doc/users/set-user-properties-9052829

public SetUserProperties ( object>.Dictionary properties ) : Task
properties	object>.Dictionary	The JSON object value of the property
return	Task

SetUserProperty() public method

Sets the value of the property for the active user with the given name. The property is specific to the auth client used.

Podio API Reference: https://developers.podio.com/doc/users/set-user-property-29799

public SetUserProperty ( string name, dynamic value ) : Task
name	string
value	dynamic
return	Task

UpdateNotificationSetting() public method

Updates the setting for the given client type and notification type.

Podio API Reference: https://developers.podio.com/doc/users/update-notification-setting-3649918

public UpdateNotificationSetting ( string clientType, string notificationType, bool value ) : Task
clientType	string	Client type: "email" and "mobile".
notificationType	string	/// Notification type: "digest", "bulletin", "reference", "message", "space", /// "subscription", "user", "reminder", "push_notification", "push_notification_sound" or "push_notification_browser". ///
value	bool
return	Task

UpdateNotificationSettings() public method

Updates the setting for the given client type

Podio API Reference: https://developers.podio.com/doc/users/update-notification-settings-3649927

public UpdateNotificationSettings ( string clientType, bool>.Dictionary notificationTypes ) : Task
clientType	string	Client type: "email" and "mobile".
notificationTypes	bool>.Dictionary	/// Notification type: "digest", "bulletin", "reference", "message", "space", /// "subscription", "user", "reminder", "push_notification", "push_notification_sound" or "push_notification_browser". ///
return	Task

UpdateProfile() public method

Updates the fields of an existing profile. Fields not specified will not be updated. To delete a field set the value of the field to null.

Podio API Reference: https://developers.podio.com/doc/users/update-profile-22402

public UpdateProfile ( Contact updatedProfile ) : Task
updatedProfile	PodioAPI.Models.Contact	The value or list of values for the given field. For a list of fields see the contact area
return	Task

UpdateProfileField() public method

Updates the specific field on the user.

Podio API Reference: https://developers.podio.com/doc/users/update-profile-field-22500

public UpdateProfileField ( string key, string value ) : Task
key	string
value	string	The new value for the profile field.
return	Task

UserService() public method

public UserService ( Podio currentInstance ) : System.Collections.Generic
currentInstance	Podio
return	System.Collections.Generic