Class RoleRequestFactory
Inheritance
System.Object
RoleRequestFactory
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 RoleRequestFactory : IRoleRequestFactoryConstructors
RoleRequestFactory()
Declaration
public RoleRequestFactory()Methods
Add(AddRoleRequest)
Receives AddRoleRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Add(AddRoleRequest addRequest)Parameters
| Type | Name | Description |
|---|---|---|
| AddRoleRequest | addRequest | the request object used to add a new Role |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
Assign(String, RoleAssignmentRequest)
Declaration
public HttpRequestMessage Assign(string roleId, RoleAssignmentRequest roleAssignment)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | roleId | |
| RoleAssignmentRequest | roleAssignment |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |
GetByCriteria(GetRolesByCriteriaRequest)
Receives GetRolesByCriteriaRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage GetByCriteria(GetRolesByCriteriaRequest getByCriteriaRequest)Parameters
| Type | Name | Description |
|---|---|---|
| GetRolesByCriteriaRequest | getByCriteriaRequest | the request object used to retrieve the desired result page of Roles |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
GetById(String, GetRoleByIdRequest)
Receives GetRoleByIdRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage GetById(string roleId, GetRoleByIdRequest getByIdRequest)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | roleId | |
| GetRoleByIdRequest | getByIdRequest | the request object used to retrieve the desired Role |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
IsAssigned(String, RoleAssignmentRequest)
Declaration
public HttpRequestMessage IsAssigned(string roleId, RoleAssignmentRequest roleAssignment)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | roleId | |
| RoleAssignmentRequest | roleAssignment |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |
Remove(String)
Receives RoleId and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Remove(string RoleId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | RoleId | The id of the Role that is to be updated |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |
Unassign(String, RoleAssignmentRequest)
Declaration
public HttpRequestMessage Unassign(string roleId, RoleAssignmentRequest roleAssignment)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | roleId | |
| RoleAssignmentRequest | roleAssignment |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage |
Update(String, UpdateRoleRequest)
Receives RoleId and UpdateRoleRequest and returns new HttpRequestMessage
Declaration
public HttpRequestMessage Update(string roleId, UpdateRoleRequest updateRequest)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | roleId | The id of the role that is to be updated |
| UpdateRoleRequest | updateRequest | The request object to be converted to httpcontent |
Returns
| Type | Description |
|---|---|
| System.Net.Http.HttpRequestMessage | HttpRequestMessage |