Class AssociationRequestFactory
Inheritance
Implements
Inherited Members
Namespace: EPiServer.Social.Groups.Rest
Assembly: EPiServer.Social.Groups.Rest.dll
Version: 1.5.4Syntax
public class AssociationRequestFactory : IAssociationRequestFactory
Constructors
AssociationRequestFactory()
Declaration
public AssociationRequestFactory()
Methods
Add(AddAssociationRequest)
Receives AddAssociationRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Add(AddAssociationRequest addRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| AddAssociationRequest | addRequest | the request object used to add a new Association |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
GetByCriteria(GetAssociationsByCriteriaRequest)
Receives GetAssociationsByCriteriaRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage GetByCriteria(GetAssociationsByCriteriaRequest getByCriteriaRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| GetAssociationsByCriteriaRequest | getByCriteriaRequest | the request object used to retrieve the desired result page of Associations |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
GetById(GetAssociationByIdRequest)
Receives GetAssociationByIdRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage GetById(GetAssociationByIdRequest getByIdRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| GetAssociationByIdRequest | getByIdRequest | the request object used to retrieve the desired Association |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
Remove(String)
Receives AssociationId and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Remove(string associationId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | associationId | The id of the Association that is to be updated |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
Update(String, UpdateAssociationRequest)
Receives AssociationId and UpdateAssociationRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Update(string associationId, UpdateAssociationRequest updateRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | associationId | The id of the Association that is to be updated |
| UpdateAssociationRequest | updateRequest | The request object to be converted to httpcontent |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |