AI OnAI Offsmart_toy

Class CommentResponseMessageHandler

The CommentResponseMessageHandler class is responsible for interpreting HTTP response messages returned by the Comments REST service.

Inheritance
System.Object
ResponseMessageHandler
CommentResponseMessageHandler
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.Comments.Rest
Assembly: EPiServer.Social.Comments.Rest.dll
Version: 1.5.4
Syntax
public class CommentResponseMessageHandler : ResponseMessageHandler

Constructors

CommentResponseMessageHandler()

Constructor

Declaration
public CommentResponseMessageHandler()

Methods

HandleAdd(HttpResponseMessage)

Handles response messages for an "Add" request issued to the Comments REST service.

Declaration
public Task<Comment> HandleAdd(HttpResponseMessage httpResponseMessage)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
Returns
Type Description
System.Threading.Tasks.Task<Comment>

Comment from the response

HandleAdd<TExtension>(HttpResponseMessage)

Handles response messages for an "Add" request issued to the Comments REST service.

Declaration
public Task<Composite<Comment, TExtension>> HandleAdd<TExtension>(HttpResponseMessage httpResponseMessage)
    where TExtension : class
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
Returns
Type Description
System.Threading.Tasks.Task<Composite<Comment, TExtension>>

Composite comment from the response
Type Parameters
Name Description
TExtension

Type of extension data

HandleGetByCriteria(HttpResponseMessage, PageInfo)

Handles response messages for a "Get by criteria" request issued to the Comments REST service.

Declaration
public Task<ResultPage<Comment>> HandleGetByCriteria(HttpResponseMessage httpResponseMessage, PageInfo pageInfo)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
PageInfo pageInfo

Paging information
Returns
Type Description
System.Threading.Tasks.Task<ResultPage<Comment>>

Result page of comments from the response

HandleGetByCriteria<TExtension>(HttpResponseMessage, PageInfo)

Handles response messages for a "Get by criteria" request issued to the Comments REST service.

Declaration
public Task<ResultPage<Composite<Comment, TExtension>>> HandleGetByCriteria<TExtension>(HttpResponseMessage httpResponseMessage, PageInfo pageInfo)
    where TExtension : class
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
PageInfo pageInfo

Paging information
Returns
Type Description
System.Threading.Tasks.Task<ResultPage<Composite<Comment, TExtension>>>

Result page of composite comments from the response
Type Parameters
Name Description
TExtension

Type of extension data

HandleGetById(HttpResponseMessage)

Handles response messages for a "Get by ID" request issued to the Comments REST service.

Declaration
public Task<Comment> HandleGetById(HttpResponseMessage httpResponseMessage)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
Returns
Type Description
System.Threading.Tasks.Task<Comment>

Comment from the response

HandleGetById<TExtension>(HttpResponseMessage)

Handles response messages for a "Get by ID" request issued to the Comments REST service.

Declaration
public Task<Composite<Comment, TExtension>> HandleGetById<TExtension>(HttpResponseMessage httpResponseMessage)
    where TExtension : class
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
Returns
Type Description
System.Threading.Tasks.Task<Composite<Comment, TExtension>>

Composite comment from the response
Type Parameters
Name Description
TExtension

Type of extension data

HandleRemove(HttpResponseMessage)

Handles response messages for a "Remove" request issued to the Comments REST service.

Declaration
public Task HandleRemove(HttpResponseMessage httpResponseMessage)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
Returns
Type Description
System.Threading.Tasks.Task

HandleUnsuccessful(HttpResponseMessage)

Handles responses which indicate that the request was unsuccessful.

Declaration
public override Task HandleUnsuccessful(HttpResponseMessage httpResponseMessage)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
Returns
Type Description
System.Threading.Tasks.Task
Overrides

HandleUpdate(HttpResponseMessage)

Handles response messages for an "Update" request issued to the Comments REST service.

Declaration
public Task<Comment> HandleUpdate(HttpResponseMessage httpResponseMessage)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
Returns
Type Description
System.Threading.Tasks.Task<Comment>

Comment from the response

HandleUpdate<TExtension>(HttpResponseMessage)

Handles response messages for an "Update" request issued to the Comments REST service.

Declaration
public Task<Composite<Comment, TExtension>> HandleUpdate<TExtension>(HttpResponseMessage httpResponseMessage)
    where TExtension : class
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage httpResponseMessage

Response message to handle
Returns
Type Description
System.Threading.Tasks.Task<Composite<Comment, TExtension>>

Composite comment from the response
Type Parameters
Name Description
TExtension

Type of extension data
arrow_upward