This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IFriendships>() and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterCreate
Handler
void FriendshipAfterCreateEventHandler(FriendshipAfterCreateEventArgs e);
Events.AfterDelete
Handler
void FriendshipAfterDeleteEventHandler(FriendshipAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void FriendshipAfterUpdateEventHandler(FriendshipAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void FriendshipBeforeCreateEventHandler(FriendshipBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void FriendshipBeforeDeleteEventHandler(FriendshipBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void FriendshipBeforeUpdateEventHandler(FriendshipBeforeUpdateEventArgs e);
Methods
Friendship Create(int recipientId, string requestMessage, FriendshipsCreateOptions options = null);
Create a friendship relationship
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| recipientId | int | Recipient Id | Required | ||
| requestMessage | string | Request message | Required | ||
| options | FriendshipsCreateOptions | Optional parameter names are: RequestorId, RequestorName | Optional |
Return Type
AdditionalInfo Delete(FriendshipsDeleteOptions options);
Deletes a friendship relationship
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | FriendshipsDeleteOptions | Optional parameter names are: RequestorId, RequestorName, RecipientId, RecipientName | Required |
Return Type
Friendship Get(FriendshipsGetOptions options);
Gets a friendship
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | FriendshipsGetOptions | Optional Parameters are UserId (user making the request), Username (user making the request), FriendId, FriendName | Required |
Return Type
PagedList<Friendship> List(FriendshipsListOptions options = null);
List friendships
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | FriendshipsListOptions | Optional parameter names are: RequestorId, RecipientId, FriendshipState, PageSize, PageIndex, SortBy, SortOrder, SearchText, Presence. If left unspecified, sorting defaults to CreatedDate Ascending. | Optional |
Return Type
Friendship Update(string friendshipState, FriendshipsUpdateOptions options);
Updates a friendship status
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| friendshipState | string | Friendship State | Required | Approved, NotSpecified, Pending | |
| options | FriendshipsUpdateOptions | Optional parameter names are: FrienshipState, RequestorId, RequestorName, RecipientId, RecipientName | Required |