C# Class PodioAPI.Services.GrantService

Show file Open project: podio/podio-dotnet

Public Methods

Method	Description
CountGrantsOnObject ( string refType, dynamic refId ) : Task	Returns the count of grants on the given object. Podio API Reference: https://developers.podio.com/doc/grants/count-grants-on-object-19275931
CreateGrant ( string refType, int refId, List people, string action, string message = null ) : Task	Create a grant on the given object to the given users. Podio API Reference: https://developers.podio.com/doc/grants/create-grant-16168841
GetGrantsOnObject ( string refType, dynamic refId ) : Task>	Returns the grants on the given object. Podio API Reference: https://developers.podio.com/doc/grants/get-grants-on-object-16491464
GetGrantsToUserOnSpace ( int spaceId, int userId ) : Task>	Returns all the grants for the user on the given space. Podio API Reference: https://developers.podio.com/doc/grants/get-grants-to-user-on-space-19389786
GetOwnGrantInformation ( string refType, dynamic refId ) : Task	Return the grant information for the active user, if any Podio API Reference: https://developers.podio.com/doc/grants/get-own-grant-information-16490748
GetOwnGrantsOnOrg ( int orgId ) : Task>	Returns all the grants for the current user on the given organization. Podio API Reference: https://developers.podio.com/doc/grants/get-own-grants-on-org-22330891
GrantService ( Podio currentInstance ) : System.Collections.Generic
RemoveGrant ( string refType, dynamic refId, int userId ) : Task	Removes the grant from the given user on the given object. Podio API Reference: https://developers.podio.com/doc/grants/remove-grant-16496711

Method Details

CountGrantsOnObject() public method

Returns the count of grants on the given object.

Podio API Reference: https://developers.podio.com/doc/grants/count-grants-on-object-19275931

public CountGrantsOnObject ( string refType, dynamic refId ) : Task
refType	string
refId	dynamic
return	Task

CreateGrant() public method

Create a grant on the given object to the given users.

Podio API Reference: https://developers.podio.com/doc/grants/create-grant-16168841

public CreateGrant ( string refType, int refId, List people, string action, string message = null ) : Task
refType	string
refId	int
people	List	The list of people to grant access to. This is a list of contact identifiers
action	string	The action required of the people, either "view", "comment" or "rate", or left out
message	string	Any special message to the users
return	Task

GetGrantsOnObject() public method

Returns the grants on the given object.

Podio API Reference: https://developers.podio.com/doc/grants/get-grants-on-object-16491464

public GetGrantsOnObject ( string refType, dynamic refId ) : Task>
refType	string
refId	dynamic
return	Task>

GetGrantsToUserOnSpace() public method

Returns all the grants for the user on the given space.

Podio API Reference: https://developers.podio.com/doc/grants/get-grants-to-user-on-space-19389786

public GetGrantsToUserOnSpace ( int spaceId, int userId ) : Task>
spaceId	int
userId	int
return	Task>

GetOwnGrantInformation() public method

Return the grant information for the active user, if any

Podio API Reference: https://developers.podio.com/doc/grants/get-own-grant-information-16490748

public GetOwnGrantInformation ( string refType, dynamic refId ) : Task
refType	string
refId	dynamic
return	Task

GetOwnGrantsOnOrg() public method

Returns all the grants for the current user on the given organization.

Podio API Reference: https://developers.podio.com/doc/grants/get-own-grants-on-org-22330891

public GetOwnGrantsOnOrg ( int orgId ) : Task>
orgId	int
return	Task>

GrantService() public method

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

RemoveGrant() public method

Removes the grant from the given user on the given object.

Podio API Reference: https://developers.podio.com/doc/grants/remove-grant-16496711

public RemoveGrant ( string refType, dynamic refId, int userId ) : Task
refType	string
refId	dynamic
userId	int
return	Task