C# Class PodioAPI.Services.ReferenceService

Mostrar archivo Open project: podio/podio-dotnet

Public Methods

Method	Description
CountUserWithAccess ( string refType, int refId ) : Task	Returns the number of other users with access to the given object. Podio API Reference: https://developers.podio.com/doc/reference/count-user-profiles-with-access-to-object-19190550
FindUserWithAccess ( string refType, int refId, int limit = null, int offset = null ) : Task>	Returns user profiles who have access to an object, either because they have been explicitly granted access to it or because they are members of the object's workspace. Podio API Reference: https://developers.podio.com/doc/reference/get-user-profiles-with-access-to-object-16681010
GetReference ( string refType, int refId, bool accessorCount = false, int contextId = null, string contextType = null ) : Task	Returns information about the reference. Podio API Reference: https://developers.podio.com/doc/reference/get-reference-10661022
ReferenceService ( Podio currentInstance ) : System.Collections.Generic
ResolveURL ( string referenceUrl ) : Task	Resolves the url given in the parameter to a reference. If the URL could not be resolved, status code 404 will be returned. If the user does not have access to the URL, status code 403 will be returned. Podio API Reference: https://developers.podio.com/doc/reference/resolve-url-66839423
SearchReferences ( SearchReferencesRequest searchReferenceRequest ) : Task>	Search for references for use in various contexts. Podio API Reference: https://developers.podio.com/doc/reference/search-references-13312595

Method Details

CountUserWithAccess() public method

Returns the number of other users with access to the given object.

Podio API Reference: https://developers.podio.com/doc/reference/count-user-profiles-with-access-to-object-19190550

public CountUserWithAccess ( string refType, int refId ) : Task
refType	string
refId	int
return	Task

FindUserWithAccess() public method

Returns user profiles who have access to an object, either because they have been explicitly granted access to it or because they are members of the object's workspace.

Podio API Reference: https://developers.podio.com/doc/reference/get-user-profiles-with-access-to-object-16681010

public FindUserWithAccess ( string refType, int refId, int limit = null, int offset = null ) : Task>
refType	string
refId	int
limit	int	The maximum number of profiles to return for each access type
offset	int	The offset into the profiles to return
return	Task>

GetReference() public method

Returns information about the reference.

Podio API Reference: https://developers.podio.com/doc/reference/get-reference-10661022

public GetReference ( string refType, int refId, bool accessorCount = false, int contextId = null, string contextType = null ) : Task
refType	string
refId	int
accessorCount	bool	/// If true, the response will include an "accessor_count" property, the number of users that /// have access to this object. Default value: false ///
contextId	int	The id of the context to check the reference against.
contextType	string	The context type to check the reference against. Currently only supports "app".
return	Task

ReferenceService() public method

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

ResolveURL() public method

Resolves the url given in the parameter to a reference. If the URL could not be resolved, status code 404 will be returned. If the user does not have access to the URL, status code 403 will be returned.

Podio API Reference: https://developers.podio.com/doc/reference/resolve-url-66839423

public ResolveURL ( string referenceUrl ) : Task
referenceUrl	string	/// Currently supported URL's are: App market app/pack, App, File permalink, Item permalink, /// Space, Status permalink, Task permalink, User profile ///
return	Task

SearchReferences() public method

Search for references for use in various contexts.

Podio API Reference: https://developers.podio.com/doc/reference/search-references-13312595

public SearchReferences ( SearchReferencesRequest searchReferenceRequest ) : Task>
searchReferenceRequest	PodioAPI.Models.Request.SearchReferencesRequest
return	Task>