Class HmacMessage

The HmacMessage class represents the payload parameter for the cryptographic signature associated with a request using the Social platform's HMAC implementation for authentication.

Inheritance
System.Object
HmacMessage
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.Common.Rest.Contracts
Assembly: EPiServer.Social.Common.Rest.Contracts.dll
Version: 1.5.4
Syntax
public class HmacMessage

Constructors

HmacMessage()

Declaration
public HmacMessage()

Methods

AddNonce(String)

Adds the request's nonce value to the message.

Declaration
public HmacMessage AddNonce(string nonce)
Parameters
Type Name Description
System.String nonce

Request's nonce value

Returns
Type Description
HmacMessage

Reference to this HmacMessage

AddRequestContent(Byte[])

Adds the associated request's content to the message.

Declaration
public HmacMessage AddRequestContent(byte[] content)
Parameters
Type Name Description
System.Byte[] content

Request content

Returns
Type Description
HmacMessage

Reference to this HmacMessage

AddRequestMethod(String)

Adds the associated request's HTTP method to the message.

Declaration
public HmacMessage AddRequestMethod(string httpMethod)
Parameters
Type Name Description
System.String httpMethod

Request's method

Returns
Type Description
HmacMessage

Reference to this HmacMessage

AddRequestUri(Uri)

Adds the associated request's URI to the message.

Declaration
public HmacMessage AddRequestUri(Uri uri)
Parameters
Type Name Description
System.Uri uri

Request URI

Returns
Type Description
HmacMessage

Reference to this HmacMessage

AddTenantId(String)

Adds the requesting tenant's identifier to the message.

Declaration
public HmacMessage AddTenantId(string id)
Parameters
Type Name Description
System.String id

Application ID

Returns
Type Description
HmacMessage

Reference to this HmacMessage

AddTimestamp(String)

Adds the associated request's timestamp to the message.

Declaration
public HmacMessage AddTimestamp(string timestamp)
Parameters
Type Name Description
System.String timestamp

Request timestamp

Returns
Type Description
HmacMessage

Reference to this HmacMessage

ToBytes()

Returns a byte array representative of this message's content.

Declaration
public byte[] ToBytes()
Returns
Type Description
System.Byte[]

Message as a byte array

arrow_upward