Class GroupRequestFactory
Inheritance
System.Object
GroupRequestFactory
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Social.Groups.Rest
Assembly: EPiServer.Social.Groups.Rest.dll
Version: 1.5.4Syntax
public class GroupRequestFactory : IGroupRequestFactoryConstructors
GroupRequestFactory()
Declaration
public GroupRequestFactory()Methods
Add(AddGroupRequest)
Receives AddGroupRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Add(AddGroupRequest addRequest)Parameters
| Type | Name | Description |
|---|---|---|
| AddGroupRequest | addRequest | the request object used to add a new group |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
GetByCriteria(GetGroupsByCriteriaRequest)
Receives GetGroupsByCriteriaRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage GetByCriteria(GetGroupsByCriteriaRequest getByCriteriaRequest)Parameters
| Type | Name | Description |
|---|---|---|
| GetGroupsByCriteriaRequest | getByCriteriaRequest | the request object used to retrieve the desired result page of groups |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
GetById(GetGroupByIdRequest)
Receives GetGroupByIdRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage GetById(GetGroupByIdRequest getByIdRequest)Parameters
| Type | Name | Description |
|---|---|---|
| GetGroupByIdRequest | getByIdRequest | the request object used to retrieve the desired group |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
Remove(String)
Receives groupId and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Remove(string groupId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | groupId | The id of the group that is to be updated |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
Update(String, UpdateGroupRequest)
Receives groupId and UpdateGroupRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Update(string groupId, UpdateGroupRequest updateRequest)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | groupId | The id of the group that is to be updated |
| UpdateGroupRequest | updateRequest | The request object to be converted to httpcontent |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |