C# Class Net.Pokeshot.JiveSdk.Clients.MembersClient

Inheritance: JiveClient

Mostra file Open project: jivesoftware/JiveDotNetSDK

Private Properties

Property	Type	Description

Public Methods

Method	Description
GetMember ( int memberID, List fields = null ) : Member	Return the specified membership.
GetMembersByGroup ( int placeID, List state = null, int count = 25, int startIndex, List filter = null, List fields = null ) : List	Retrieve all memberships of a given group that match the specified criteria.
GetMembersByPerson ( int personID, List state = null, int count = 25, int startIndex, List filter = null, List fields = null ) : List	Retrieve all memberships of a given person that match the specified criteria.
MembersClient ( string communityUrl, NetworkCredential credentials ) : System

Method Details

GetMember() public method

Return the specified membership.

public GetMember ( int memberID, List fields = null ) : Member
memberID	int	ID of the membership to be returned.
fields	List	Fields to include in the returned Member.
return	Net.Pokeshot.JiveSdk.Models.Member

GetMembersByGroup() public method

Retrieve all memberships of a given group that match the specified criteria.

public GetMembersByGroup ( int placeID, List state = null, int count = 25, int startIndex, List filter = null, List fields = null ) : List
placeID	int	Group ID of the social group for which to select memberships.
state	List	List of states used to filter the returned results (default is all states). Possible values are: 'banned', 'invited', 'member', 'owner' and 'pending'.
count	int	Maximum number of memberships to be returned (default is 25).
startIndex	int	Zero-relative offset of the first membership to be returned (default is 0).
filter	List	The filter criteria used to select memberships
fields	List	Fields to be returned in the selected memberships.
return	List

GetMembersByPerson() public method

Retrieve all memberships of a given person that match the specified criteria.

public GetMembersByPerson ( int personID, List state = null, int count = 25, int startIndex, List filter = null, List fields = null ) : List
personID	int	ID of the person for which to select memberships.
state	List	List of states used to filter the returned results (default is all states). Possible values are: 'banned', 'invited', 'member', 'owner' and 'pending'.
count	int	Maximum number of memberships to be returned (default is 25).
startIndex	int	Zero-relative offset of the first membership to be returned (default is 0).
filter	List	The filter criteria used to select memberships
fields	List	Fields to be returned in the selected memberships.
return	List

MembersClient() public method

public MembersClient ( string communityUrl, NetworkCredential credentials ) : System
communityUrl	string
credentials	System.Net.NetworkCredential
return	System