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

Inheritance: JiveClient

Mostrar archivo Open project: jivesoftware/JiveDotNetSDK

Private Properties

Property	Type	Description

Public Methods

Method	Description
AcceptTermsAndConditions ( string personID ) : void	Accept the terms and conditions for the authenticated user.
AddExpertiseTags ( int personID, List tags ) : void	Add expertise tag(s) to a person
ApproveExpertiseTag ( int personID, string tagName ) : void	Used to approve a tag that user has been endorsed with. The current user and the specified user must be the same or an authorization error will occur.
CreatePage ( string personID, Page page ) : void	Create a new Page object for a user based on the contents of the specified Page. Only modifiable fields that actually provide a value in the incoming entity are processed.
CreatePerson ( Person new_person, bool welcome = false, System.DateTime published = null, List fields = null ) : Person	Create a Person object for a new user based on the contents of the specified Person. Only modifiable fields that actually provide a value in the incoming entity are processed.
CreateTask ( int personID, Models task, List fields = null ) : Models.Task	Create a personal task.
DestroyAvatar ( int personID ) : void	Delete the active avatar for the specified user. Only uploaded avatars can be deleted. The system avatar will be selected for the user after the delete operation is completed.
DestroyExpertiseTag ( int personID, string tagName ) : void	Remove an expertise tag from a person. Note: backslashes are not allowed in the tagName string.
DestroyExpertiseTag2 ( int personID, string tagName ) : void	Remove an expertise tag from a person, where the name of the tag is specified via a query string. This alternative version allows backslashes in the tag name.
DestroyFollowing ( int personID, int followedPersonID ) : void	Delete a following relationship between the specified user and the specified followed user.
DestroyPerson ( int personID ) : void	Trigger a background task to delete the specified person, and all of their content. Returns an HTTP 202 (Accepted) status to indicate that the deletion request has been accepted. The only way that a client can tell it has been completed is by trying a GET on the person URI, and waiting until a NotFoundException is returned. WARNING = It is possible that errors during the deletion process might cause the delete to be abandoned.
DestroyProfileImage ( int personID, int index ) : void	Delete the specified profile image for the specified user.
DestroyReport ( int personID, int reportPersonID ) : void	Delete (i.e. retire) an existing manager-report relationship between the specified manager user and the specified report user.
FindPerson ( Person extPerson ) : Person	Method used for importing content from another site and an author for the content is required. The method first checks to see if any user with any of the external user's emails is already present on the site, and returns it if present, otherwise getting or creating and returning a default "anonymous" user to be used for the import. Note: this will print an error message to the console for every email tried that isn't present, this can be commented out in GetAbsolute in JiveClient
FindPersonByEmail ( string email ) : Person	Method used for importing content from another site and an author for the content is required. The method first checks to see if any user with the external user's email is already present on the site, and returns it if present, otherwise getting or creating and returning a default "anonymous" user to be used for the import. Note: this will print an error message to the console if the email tried isn't present, this can be commented out in GetAbsolute in JiveClient
GetActivity ( int personID, System.DateTime time = null, bool after = false, int count = 25, List filter = null, List fields = null ) : List	Return the specified profile activities for the specified user.
GetAllPeople ( int count = 25, int startIndex, List fields = null, bool includeDisabled = false, bool includeExternal = false, bool visibleOnly = true ) : List	Return a paginated list of Persons for users that match the specified criteria. Users will be sorted by userID ascending.
GetAvatar ( int personID, int width = null, int height = null, bool preserveAspectRatio = null ) : byte[]	Return the binary content of the avatar image for the specified user.
GetAvatarDeactivated ( int width = null, int height = null, bool preserveAspectRatio = null ) : byte[]	Return the binary content of the avatar image for deactivated users.
GetBlog ( int personID, List fields = null ) : Blog	Return the personal blog for the specified user.
GetColleagues ( int personID, int count = 25, int startIndex, List fields = null ) : List	Return a paginated list of Person objects about colleagues of the specified person (i.e. those who report to the same manager that this person does).
GetCommonBidirectional ( int personID, int count = 25, int startIndex, List fields = null ) : List	Return a paginated list of Persons about bidirectionally related users that you and the specified person have in common (i.e. any person whom you and the specified person are both following, and who is following both you and specified person).
GetFeaturedContent ( int personID, List types = null, List fields = null, bool abridged = false ) : List	Return a list of featured content objects for the specified person.
GetFilterableFields ( ) : List	Return the set of fields that can be used for filtering users in this Jive instance.
GetFollowers ( int personID, int count = 25, int startIndex, List fields = null ) : List	Return a paginated list of Persons about people who are following the specified person.
GetFollowing ( int personID, int count = 25, int startIndex, List fields = null ) : List	Return a paginated list of Persons about people the specified person is following.
GetFollowingPerson ( int personID, int followedPersonID, List fields = null ) : Person	Return a Person describing the followed person, if a following relationship from the specified person exists.
GetManager ( int personID, List fields = null ) : Person	Return a Person describing the manager of the specified person.
GetPages ( int personID ) : Page	Return a list of pages(currently only one) Page that a user has created with parent as user. currently you can only create one page with user as parent
GetPeople ( List ids = null, List query = null, int startIndex, int count = 25, List fields = null, string sort = "firstNameAsc", string company = null, string department = null, DateTime?>.Tuple hireDate = null, bool includeDisabled = false, bool includeExternal = false, bool includeOnline = false, bool includePartner = true, DateTime?>.Tuple lastProfileUpdate = null, string location = null, bool nameonly = false, DateTime?>.Tuple published = null, List search = null, List tag = null, string title = null, DateTime?>.Tuple updated = null ) : List	Return a list of Persons for users that match the specified criteria.
GetPerson ( int personID, List fields = null ) : Person	Return a Person describing the requested Jive user by ID.
GetPersonByEmail ( string email, List fields = null ) : Person	Return a Person describing the requested Jive user by email address.
GetPersonByUsername ( string username, List fields = null ) : Person	Return a Person object describing the requested Jive user by username.
GetStreams ( int personID, List fields = null ) : List	Return a list of Streams for the specified user. Because the number of streams will generally be very small, pagination is not supported.
PeopleClient ( string communityUrl, NetworkCredential credentials ) : System
UpdateFollowing ( int personID, int followedPersonID ) : void	Create a following relationship between the specified user the specified followed user.

Method Details

AcceptTermsAndConditions() public method

Accept the terms and conditions for the authenticated user.

public AcceptTermsAndConditions ( string personID ) : void
personID	string	Authenticated user. User @me or the ID of the authenticated user.
return	void

AddExpertiseTags() public method

Add expertise tag(s) to a person

public AddExpertiseTags ( int personID, List tags ) : void
personID	int	ID of the person
tags	List	a string list of tags, limited to 200 tags per call
return	void

ApproveExpertiseTag() public method

Used to approve a tag that user has been endorsed with. The current user and the specified user must be the same or an authorization error will occur.

public ApproveExpertiseTag ( int personID, string tagName ) : void
personID	int	Current user ID
tagName	string	Name of the tag to approve endorsements for
return	void

CreatePage() public method

Create a new Page object for a user based on the contents of the specified Page. Only modifiable fields that actually provide a value in the incoming entity are processed.

public CreatePage ( string personID, Page page ) : void
personID	string	Authenticated user. Use @me or the ID of the authenticated user
page	Net.Pokeshot.JiveSdk.Models.Page	the Page object containing the information on the page to be created
return	void

CreatePerson() public method

Create a Person object for a new user based on the contents of the specified Person. Only modifiable fields that actually provide a value in the incoming entity are processed.

public CreatePerson ( Person new_person, bool welcome = false, System.DateTime published = null, List fields = null ) : Person
new_person	Net.Pokeshot.JiveSdk.Models.Person	the Person object containing information describing the new user
welcome	bool	Flag indicating that a welcome email should be sent to the newly created user
published	System.DateTime	Date and time when this person was originally created. Only set this field when importing people.
fields	List	The fields to include in the returned entity
return	Net.Pokeshot.JiveSdk.Models.Person

CreateTask() public method

Create a personal task.

public CreateTask ( int personID, Models task, List fields = null ) : Models.Task
personID	int	ID of the user for which to create a task
task	Models	Task object containing information describing the personal task
fields	List	fields to return in the returned Task object
return	Models.Task

DestroyAvatar() public method

Delete the active avatar for the specified user. Only uploaded avatars can be deleted. The system avatar will be selected for the user after the delete operation is completed.

public DestroyAvatar ( int personID ) : void
personID	int	ID of the specified user
return	void

DestroyExpertiseTag() public method

Remove an expertise tag from a person. Note: backslashes are not allowed in the tagName string.

public DestroyExpertiseTag ( int personID, string tagName ) : void
personID	int	ID of the person
tagName	string	Name of the tag
return	void

DestroyExpertiseTag2() public method

Remove an expertise tag from a person, where the name of the tag is specified via a query string. This alternative version allows backslashes in the tag name.

public DestroyExpertiseTag2 ( int personID, string tagName ) : void
personID	int	ID of the person
tagName	string	Name of the tag
return	void

DestroyFollowing() public method

Delete a following relationship between the specified user and the specified followed user.

public DestroyFollowing ( int personID, int followedPersonID ) : void
personID	int	ID of the user who is following
followedPersonID	int	ID of the user who is followed
return	void

DestroyPerson() public method

Trigger a background task to delete the specified person, and all of their content. Returns an HTTP 202 (Accepted) status to indicate that the deletion request has been accepted. The only way that a client can tell it has been completed is by trying a GET on the person URI, and waiting until a NotFoundException is returned. WARNING = It is possible that errors during the deletion process might cause the delete to be abandoned.

public DestroyPerson ( int personID ) : void
personID	int	ID of the person to be deleted
return	void

DestroyProfileImage() public method

Delete the specified profile image for the specified user.

public DestroyProfileImage ( int personID, int index ) : void
personID	int	ID of the specified user
index	int	1-relative index of the specified profile image
return	void

DestroyReport() public method

Delete (i.e. retire) an existing manager-report relationship between the specified manager user and the specified report user.

public DestroyReport ( int personID, int reportPersonID ) : void
personID	int	ID of the user which is the manager in the existing relationship
reportPersonID	int	ID of the user which is the direct report in the existing relationship
return	void

FindPerson() public method

Method used for importing content from another site and an author for the content is required. The method first checks to see if any user with any of the external user's emails is already present on the site, and returns it if present, otherwise getting or creating and returning a default "anonymous" user to be used for the import. Note: this will print an error message to the console for every email tried that isn't present, this can be commented out in GetAbsolute in JiveClient

public FindPerson ( Person extPerson ) : Person
extPerson	Net.Pokeshot.JiveSdk.Models.Person	the Person object from the external site (usually the author of the external content)
return	Net.Pokeshot.JiveSdk.Models.Person

FindPersonByEmail() public method

Method used for importing content from another site and an author for the content is required. The method first checks to see if any user with the external user's email is already present on the site, and returns it if present, otherwise getting or creating and returning a default "anonymous" user to be used for the import. Note: this will print an error message to the console if the email tried isn't present, this can be commented out in GetAbsolute in JiveClient

public FindPersonByEmail ( string email ) : Person
email	string	the email from the external site (usually the author of the external content)
return	Net.Pokeshot.JiveSdk.Models.Person

GetActivity() public method

Return the specified profile activities for the specified user.

public GetActivity ( int personID, System.DateTime time = null, bool after = false, int count = 25, List filter = null, List fields = null ) : List
personID	int	ID of the user for which to return profile activities
time	System.DateTime	The time representing the earliest or lates time to consider (depending on the value of "after").
after	bool	If true, the request will be made for the times after "time". If false, the request is made for times before "time".
count	int	Maximum number of activities to return in this request (you may get more activities than this in order to get all of the activities in the last collection)
filter	List	Filter expression(s) used to select matching results
fields	List	Fields to be included in the returned activities
return	List

GetAllPeople() public method

Return a paginated list of Persons for users that match the specified criteria. Users will be sorted by userID ascending.

public GetAllPeople ( int count = 25, int startIndex, List fields = null, bool includeDisabled = false, bool includeExternal = false, bool visibleOnly = true ) : List
count	int	Maximum number of instances to be returned per Jive HTTP request
startIndex	int	Zero-relative index of the first instance to be returned
fields	List	Fields to be returned (or null for summary fields)
includeDisabled	bool	Include deactivated users (default=false)
includeExternal	bool	Include external users (default=false). These are users that represent external systems or are external people that have been invited to join a place.
visibleOnly	bool	Do not include invisible users (default=true means only visible users)
return	List

GetAvatar() public method

Return the binary content of the avatar image for the specified user.

public GetAvatar ( int personID, int width = null, int height = null, bool preserveAspectRatio = null ) : byte[]
personID	int	ID of the user for which to return an avatar
width	int	Suggested width for resizing the image. If image is small than the requested size then original size is preserved.
height	int	Suggested height for resizing the image. If image is small than the requested size then original size is preserved.
preserveAspectRatio	bool	boolean indicating whether to preserve the original image's aspect ratio
return	byte[]

GetAvatarDeactivated() public method

Return the binary content of the avatar image for deactivated users.

public GetAvatarDeactivated ( int width = null, int height = null, bool preserveAspectRatio = null ) : byte[]
width	int	Suggested width for resizing the image (must be less than original width)
height	int	Suggested height for resizing the image (must be less than original height)
preserveAspectRatio	bool	boolean indicating whether to preserve the original image's aspect ratio
return	byte[]

GetBlog() public method

Return the personal blog for the specified user.

public GetBlog ( int personID, List fields = null ) : Blog
personID	int	ID of the user for which to return a personal blog
fields	List	Fields to be returned (default is @all)
return	Net.Pokeshot.JiveSdk.Models.Blog

GetColleagues() public method

Return a paginated list of Person objects about colleagues of the specified person (i.e. those who report to the same manager that this person does).

public GetColleagues ( int personID, int count = 25, int startIndex, List fields = null ) : List
personID	int	ID of the specified Jive user
count	int	Maximum number of instances to be returned per Jive HTTP request (i.e. the page size)
startIndex	int	Zero-relative index of the first instance to be returned
fields	List	Fields to be returned (or null the summary fields)
return	List

GetCommonBidirectional() public method

Return a paginated list of Persons about bidirectionally related users that you and the specified person have in common (i.e. any person whom you and the specified person are both following, and who is following both you and specified person).

public GetCommonBidirectional ( int personID, int count = 25, int startIndex, List fields = null ) : List
personID	int	ID of the specified Jive user
count	int	Maximum number of instances to be returned per Jive HTTP request (i.e. the page size)
startIndex	int	Zero-relative index of the first element returned
fields	List	Fields to be returned (or null for summary fields)
return	List

GetFeaturedContent() public method

Return a list of featured content objects for the specified person.

public GetFeaturedContent ( int personID, List types = null, List fields = null, bool abridged = false ) : List
personID	int	ID of the person for which to retrieve featured content
types	List	one or more object types of desired contained content objects (document, discussion, post, poll)
fields	List	Fields to be returned on each content
abridged	bool	Flag indicating that if content.text is requested, it will be abridged (length shortened, HTML tags removed)
return	List

GetFilterableFields() public method

Return the set of fields that can be used for filtering users in this Jive instance.

public GetFilterableFields ( ) : List
return	List

GetFollowers() public method

Return a paginated list of Persons about people who are following the specified person.

public GetFollowers ( int personID, int count = 25, int startIndex, List fields = null ) : List
personID	int	ID of the specified person
count	int	Maximum number of instances to be returned (i.e. the page size)
startIndex	int	Zero-relative index of the first instance to be returned
fields	List	Fields to be returned (or null for summary fields)
return	List

GetFollowing() public method

Return a paginated list of Persons about people the specified person is following.

public GetFollowing ( int personID, int count = 25, int startIndex, List fields = null ) : List
personID	int	ID of the specified person
count	int	Maximum number of instances to be returned (i.e. the page size)
startIndex	int	Zero-relative index of the first instance to be returned
fields	List	Fields to be returned (or null for summary fields)
return	List

GetFollowingPerson() public method

Return a Person describing the followed person, if a following relationship from the specified person exists.

public GetFollowingPerson ( int personID, int followedPersonID, List fields = null ) : Person
personID	int	ID of the specified person
followedPersonID	int	ID of the followed person (if any)
fields	List	Fields to be returned (or null for all fields)
return	Net.Pokeshot.JiveSdk.Models.Person

GetManager() public method

Return a Person describing the manager of the specified person.

public GetManager ( int personID, List fields = null ) : Person
personID	int	ID of the specified Jive use
fields	List	Fields to be returned (or null for all fields)
return	Net.Pokeshot.JiveSdk.Models.Person

GetPages() public method

Return a list of pages(currently only one) Page that a user has created with parent as user. currently you can only create one page with user as parent

public GetPages ( int personID ) : Page
personID	int	Authenticated user. Use @me or the ID of the authenticated user.
return	Net.Pokeshot.JiveSdk.Models.Page

GetPeople() public method

Return a list of Persons for users that match the specified criteria.

public GetPeople ( List ids = null, List query = null, int startIndex, int count = 25, List fields = null, string sort = "firstNameAsc", string company = null, string department = null, DateTime?>.Tuple hireDate = null, bool includeDisabled = false, bool includeExternal = false, bool includeOnline = false, bool includePartner = true, DateTime?>.Tuple lastProfileUpdate = null, string location = null, bool nameonly = false, DateTime?>.Tuple published = null, List search = null, List tag = null, string title = null, DateTime?>.Tuple updated = null ) : List
ids	List	List of Person IDs of the individual people to be returned
query	List	List of Query strings containing search terms (or null for no search criteria)
startIndex	int	Zero-relative index of the first instance to be returned
count	int	Maximum number of instances to be returned (i.e. the page size)
fields	List	Fields to be returned (or null for summary fields)
sort	string	Optional sort to apply to the search results /// Sort Options: dateJoinedAsc--Sort by joined date in ascending order. /// dateJoinedDesc--Sort by joined date in descending order. /// firstNameAsc--Sort by first name in ascending order. This is the default sort order. /// lastNameAsc--Sort by last name in ascending order. /// lastProfileUpdateAsc--Sort by last profile update date/time in ascending order. /// lastProfileUpdateDesc--Sort by last profile update date/time in descending order. /// relevanceDesc--Sort by relevance, in descending order. /// statusLevelDesc--Sort by status level in descending order. /// updatedAsc--Sort by the date this person was most recently updated, in ascending order. /// updatedDesc--Sort by the date this person was most recently updated, in descending order.
company	string	Single value to match against the Company profile field.
department	string	Single value to match against the Department profile field.
hireDate	DateTime?>.Tuple	One or two dates in ISO-8601 format. One date indicates selection of all people hired on or after the specified date. Two dates indicates selection of all people hired between the specified dates.
includeDisabled	bool	Optional boolean value indicating whether disabled users should be returned (without a filter, defaults to false).
includeExternal	bool	Optional boolean value indicating whether external (non-person) users should be returned (without a filter, defaults to false).
includeOnline	bool	Optional boolean value indicating whether only online users should be returned (without a filter, defaults to false).
includePartner	bool	Optional boolean value indicating whether partner (external contributor) users should be returned (without a filter, defaults to true).
lastProfileUpdate	DateTime?>.Tuple	One or two timestamps in ISO-8601 format. If one timestamp is specified, all persons who have updated their profile since that timestamp will be selected. If two timestamps are specified, all persons who updated their profile in the specified range will be selected.
location	string	Single value to match against the Location profile field.
nameonly	bool	Optional boolean value indicating whether or not to limit search results to only people that match by name. Without a filter, defaults to false.
published	DateTime?>.Tuple	One or two timestamps in ISO-8601 format. If one timestamp is specified, all persons created since that timestamp will be selected. If two timestamps are specified, all persons created in the specified range will be selected.
search	List	One or more search terms. You must escape any of the following special characters embedded in the search terms: comma (","), backslash ("\"), left parenthesis ("("), and right parenthesis (")") by preceding them with a backslash.
tag	List	One or more tag values. A match on any of the tags will cause this person to be returned.
title	string	Single value to match against the Title profile field.
updated	DateTime?>.Tuple	One or two timestamps in ISO-8601 format. If one timestamp is specified, all persons updated since that timestamp will be selected. If two timestamps are specified, all persons updated in the specified range will be selected.
return	List

GetPerson() public method

Return a Person describing the requested Jive user by ID.

public GetPerson ( int personID, List fields = null ) : Person
personID	int	ID of the requested Jive user
fields	List	Field names to be returned (default is all)
return	Net.Pokeshot.JiveSdk.Models.Person

GetPersonByEmail() public method

Return a Person describing the requested Jive user by email address.

public GetPersonByEmail ( string email, List fields = null ) : Person
email	string	Email address of the requested Jive user
fields	List	Field names to be returned (default is @all)
return	Net.Pokeshot.JiveSdk.Models.Person

GetPersonByUsername() public method

Return a Person object describing the requested Jive user by username.

public GetPersonByUsername ( string username, List fields = null ) : Person
username	string	Username of the requested Jive user
fields	List	Field names to be returned (default is all)
return	Net.Pokeshot.JiveSdk.Models.Person

GetStreams() public method

Return a list of Streams for the specified user. Because the number of streams will generally be very small, pagination is not supported.

public GetStreams ( int personID, List fields = null ) : List
personID	int	ID of the user for whom to return custom streams
fields	List	Fields to be returned (default value is "@owned")
return	List

PeopleClient() public method

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

UpdateFollowing() public method

Create a following relationship between the specified user the specified followed user.

public UpdateFollowing ( int personID, int followedPersonID ) : void
personID	int	ID of the user who will be following
followedPersonID	int	ID of the user who will be followed
return	void