C# Class PodioAPI.Services.ContactService

Mostra file Open project: podio/podio-dotnet

Public Methods

Method	Description
ContactService ( Podio currentInstance ) : System.Collections.Generic
CreateContact ( int spaceId, Contact contact ) : Task	Creates a new space contact for use by everyone on the space. Podio API Reference: https://developers.podio.com/doc/contacts/create-space-contact-65590
DeleteContacts ( int profileIds ) : Task	Deletes the contact(s) with the given id(s). It is currently only allowed to delete contacts of type "space". Podio API Reference: https://developers.podio.com/doc/contacts/delete-contact-s-60560
GetAllContacts ( string>.Dictionary fields = null, string contactType = "user", string externalId = null, int limit = null, int offset = null, string required = null, bool excludeSelf = true, string order = "name", string type = "mini" ) : Task>	Used to get a list of contacts for the user. Podio API Reference: https://developers.podio.com/doc/contacts/get-contacts-22400
GetContactTotals ( ) : Task	Returns the total number of contacts for the active user. Podio API Reference: https://developers.podio.com/doc/contacts/get-contact-totals-v3-34629208
GetContactsByProfileId ( int profileIds, int spaceId = null ) : Task>	Returns all the contact details about the contact(s) with the given profile id(s). Podio API Reference: https://developers.podio.com/doc/contacts/get-contact-s-22335
GetOrganizationContacts ( int orgId, string>.Dictionary fields = null, string contactType = "user", string externalId = null, int limit = null, int offset = null, string required = null, bool excludeSelf = true, string order = "name", string type = "mini" ) : Task>	UsedReturns all the profiles of the users contacts on the given organization. For the details of the possible return values, see the area. Podio API Reference: https://developers.podio.com/doc/contacts/get-organization-contacts-22401
GetSkills ( string text, int limit = 12 ) : Task>	Returns the skills of related contacts, ordered by most frequently used. Podio API Reference: https://developers.podio.com/doc/contacts/get-skills-1346872
GetSpaceContactTotals ( int SpaceId ) : Task	Returns the total number of contacts on the space. Podio API Reference: https://developers.podio.com/doc/contacts/get-space-contact-totals-67508
GetSpaceContacts ( int spaceId, string>.Dictionary fields = null, string contactType = "user", string externalId = null, int limit = null, int offset = null, string required = null, bool excludeSelf = true, string order = "name", string type = "mini" ) : Task>	Returns all the profiles of the users contacts on the given space. For the details of the possible return values, see the area. Podio API Reference: https://developers.podio.com/doc/contacts/get-space-contacts-22414
GetSpaceContactsOnApp ( int appId, string>.Dictionary fields = null, int limit = null, int offset = null, string order = "name" ) : Task>	Returns all the space contacts referenced by the given app. Podio API Reference: https://developers.podio.com/doc/contacts/get-space-contacts-on-app-79475279
GetUserContact ( int userId ) : Task	Returns the contact with the given user id.
GetUserContactField ( int userId, string key ) : Task>	Returns the value of a contact with the specific field. For the possible keys to use, see the area. Podio API Reference: https://developers.podio.com/doc/contacts/get-user-contact-field-22403
GetvCard ( int profileId ) : Task	Returns the vCard for the given contact. API Reference: https://developers.podio.com/doc/contacts/get-vcard-213496
UpdateContact ( int profileId, Contact contact ) : Task	Updates the contact with the given profile id. Podio API Reference: https://developers.podio.com/doc/contacts/update-contact-60556
UpdateContactField ( int profileId, string key, string value ) : Task	Updates the given field on the given contact. Updates are currently only allowed from contacts of type "space". API Reference: https://developers.podio.com/doc/contacts/update-contact-field-60558

Method Details

ContactService() public method

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

CreateContact() public method

Creates a new space contact for use by everyone on the space.

Podio API Reference: https://developers.podio.com/doc/contacts/create-space-contact-65590

public CreateContact ( int spaceId, Contact contact ) : Task
spaceId	int
contact	PodioAPI.Models.Contact
return	Task

DeleteContacts() public method

Deletes the contact(s) with the given id(s). It is currently only allowed to delete contacts of type "space".

Podio API Reference: https://developers.podio.com/doc/contacts/delete-contact-s-60560

public DeleteContacts ( int profileIds ) : Task
profileIds	int
return	Task

GetAllContacts() public method

Used to get a list of contacts for the user.

Podio API Reference: https://developers.podio.com/doc/contacts/get-contacts-22400

public GetAllContacts ( string>.Dictionary fields = null, string contactType = "user", string externalId = null, int limit = null, int offset = null, string required = null, bool excludeSelf = true, string order = "name", string type = "mini" ) : Task>
fields	string>.Dictionary	A value for the required field. For text fields partial matches will be returned.
contactType	string	/// The types of contacts to return, can be either "user" or "space". Separate by comma to get /// multiple types, or leave blank for all contacts. Default value: user ///
externalId	string	The external id of the contact
limit	int	The maximum number of contacts that should be returned
offset	int	The offset to use when returning contacts
required	string	/// A comma-separated list of fields that should exist for the contacts returned. Useful for only /// getting contacts with an email address or phone number. ///
excludeSelf	bool	True to exclude self, False to include self. Default value: true
order	string	/// The order in which the contacts can be returned. See the area for details on the ordering options. /// Default value: name ///
type	string	Determines the way the result is returned. Valid options are "mini" and "full". Default value: mini
return	Task>

GetContactTotals() public method

Returns the total number of contacts for the active user.

Podio API Reference: https://developers.podio.com/doc/contacts/get-contact-totals-v3-34629208

public GetContactTotals ( ) : Task
return	Task

GetContactsByProfileId() public method

Returns all the contact details about the contact(s) with the given profile id(s).

Podio API Reference: https://developers.podio.com/doc/contacts/get-contact-s-22335

public GetContactsByProfileId ( int profileIds, int spaceId = null ) : Task>
profileIds	int
spaceId	int	If set the role and removable property will be set in the context of the given space.
return	Task>

GetOrganizationContacts() public method

UsedReturns all the profiles of the users contacts on the given organization. For the details of the possible return values, see the area.

Podio API Reference: https://developers.podio.com/doc/contacts/get-organization-contacts-22401

public GetOrganizationContacts ( int orgId, string>.Dictionary fields = null, string contactType = "user", string externalId = null, int limit = null, int offset = null, string required = null, bool excludeSelf = true, string order = "name", string type = "mini" ) : Task>
orgId	int
fields	string>.Dictionary	A value for the required field. For text fields partial matches will be returned.
contactType	string	/// The types of contacts to return, can be either "user" or "space". Separate by comma to get /// multiple types, or leave blank for all contacts. Default value: user ///
externalId	string	The external id of the contact
limit	int	The maximum number of contacts that should be returned
offset	int	The offset to use when returning contacts
required	string	/// A comma-separated list of fields that should exist for the contacts returned. Useful for only /// getting contacts with an email address or phone number. ///
excludeSelf	bool	True to exclude self, False to include self. Default value: true
order	string	/// The order in which the contacts can be returned. See the area for details on the ordering options. /// Default value: name ///
type	string	Determines the way the result is returned. Valid options are "mini" and "full". Default value: mini
return	Task>

GetSkills() public method

Returns the skills of related contacts, ordered by most frequently used.

Podio API Reference: https://developers.podio.com/doc/contacts/get-skills-1346872

public GetSkills ( string text, int limit = 12 ) : Task>
text	string
limit	int
return	Task>

GetSpaceContactTotals() public method

Returns the total number of contacts on the space.

Podio API Reference: https://developers.podio.com/doc/contacts/get-space-contact-totals-67508

public GetSpaceContactTotals ( int SpaceId ) : Task
SpaceId	int
return	Task

GetSpaceContacts() public method

Returns all the profiles of the users contacts on the given space. For the details of the possible return values, see the area.

Podio API Reference: https://developers.podio.com/doc/contacts/get-space-contacts-22414

public GetSpaceContacts ( int spaceId, string>.Dictionary fields = null, string contactType = "user", string externalId = null, int limit = null, int offset = null, string required = null, bool excludeSelf = true, string order = "name", string type = "mini" ) : Task>
spaceId	int
fields	string>.Dictionary	A value for the required field. For text fields partial matches will be returned.
contactType	string	/// The types of contacts to return, can be either "user" or "space". Separate by comma to get /// multiple types, or leave blank for all contacts. Default value: user ///
externalId	string	The external id of the contact
limit	int	The maximum number of contacts that should be returned
offset	int	The offset to use when returning contacts
required	string	/// A comma-separated list of fields that should exist for the contacts returned. Useful for only /// getting contacts with an email address or phone number. ///
excludeSelf	bool	True to exclude self, False to include self. Default value: true
order	string	/// The order in which the contacts can be returned. See the area for details on the ordering options. /// Default value: name ///
type	string	Determines the way the result is returned. Valid options are "mini" and "full". Default value: mini
return	Task>

GetSpaceContactsOnApp() public method

Returns all the space contacts referenced by the given app.

Podio API Reference: https://developers.podio.com/doc/contacts/get-space-contacts-on-app-79475279

public GetSpaceContactsOnApp ( int appId, string>.Dictionary fields = null, int limit = null, int offset = null, string order = "name" ) : Task>
appId	int
fields	string>.Dictionary	A value for the required field. For text fields partial matches will be returned.
limit	int	The maximum number of contacts that should be returned
offset	int	The offset to use when returning contacts
order	string	/// The order in which the contacts can be returned. See the area for details on the ordering options. /// Default value: name ///
return	Task>

GetUserContact() public method

Returns the contact with the given user id.

public GetUserContact ( int userId ) : Task
userId	int
return	Task

GetUserContactField() public method

Returns the value of a contact with the specific field. For the possible keys to use, see the area.

Podio API Reference: https://developers.podio.com/doc/contacts/get-user-contact-field-22403

public GetUserContactField ( int userId, string key ) : Task>
userId	int
key	string
return	Task>

GetvCard() public method

Returns the vCard for the given contact.

API Reference: https://developers.podio.com/doc/contacts/get-vcard-213496

public GetvCard ( int profileId ) : Task
profileId	int
return	Task

UpdateContact() public method

Updates the contact with the given profile id.

Podio API Reference: https://developers.podio.com/doc/contacts/update-contact-60556

public UpdateContact ( int profileId, Contact contact ) : Task
profileId	int
contact	PodioAPI.Models.Contact
return	Task

UpdateContactField() public method

Updates the given field on the given contact. Updates are currently only allowed from contacts of type "space".

API Reference: https://developers.podio.com/doc/contacts/update-contact-field-60558

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