Friends Class

Friends, which are the same as Colleagues in CMS400.NET, allow users to associate themselves with other users in the community. This API class allows you to manage colleagues for users in the system. For example, you can add a colleague (AddFriend), remove a colleague (DeleteFriend) or get a list of current colleagues (GetFriends).

Class Hierarchy

public class Friends : Ektron.Cms.API.Common;

Visual Basic

Public Class Friends
Inherits Ektron.Cms.API.Common

Friends.vb

Name	Description
Friends Methods	The methods of the Friends class are listed here.

Friends Methods

	Name	Description
	AcceptFriendInvite	Accepts a friend invitation on behalf of invited user.
	AcceptPendingFriend	Accepts a colleague request from one user to another.
	AddFriend	This is the overview for the AddFriend method overload.
	AddPendingFriend	Adds a pending colleague. Sends the other user a colleague invitation.
	AddSelectedFriend	Adds a colleague to a user's selected colleague list by providing the selected colleague's user ID and the ID of the user who wants to add the selected colleague.
	DeleteFriend	Delete's a colleague from a user's colleague list.
	DeletePendingFriendRequest	This is the overview for the DeletePendingFriendRequest method overload.
	DeleteSelectedFriend	Deletes a colleague from a user's selected colleague list by providing the selected colleague's user ID and the ID of the user who wants to delete the selected colleague.
	GetFriends	This is the overview for the GetFriends method overload.
	GetFriendsDirectory	Retrieves a user's colleague directory.
	GetFriendStatus	Get a user's colleague relation status to another user. For instance, user A may be a colleague to user B. User C may be a pending colleague to user D.
	GetInvitedUsers	Gets a list of users that a user has sent colleague invitations to.
	GetPendingFriends	Gets a list of users that have sent another user colleague invitations. This only returns users whose invitations have not yet been accepted and are still pending.
	GetSelectedFriends	Get a list of selected colleagues for a user by providing the user's ID.
	GetSentFriendInvitations	Gets a list of pending colleague invitations sent out by a user.
	InviteUsers	Send a friend invitation to a list of users and\or email addresses.
	IsFriend	Checks to see if a user is the colleague of another user by providing both colleague's ID information. In the friendUserID, enter the colleague's ID who you want to check. In the userID, enter the user you are checking against. Returns True when the users are colleagues. For example, if you want to find out whether Jim is a colleague of Tom, enter Jim's user ID in the friendUserId parameter and Tom's user ID in the userId parameter. If Jim and Tom are colleagues, this method returns true.
	IsSelectedFriend	Checks whether a user is a selected colleague of user.
	MoveFriend	Moves a colleague into another colleague directory.

Links

Friends Methods, Classes, Legend, Members, Topics, Friends Methods

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

[email protected].

Contents | Index | Home

What do you think about this topic? Send feedback!