Class OriginatingIdentity

Namespace

OpenServiceBroker

Assembly

OpenServiceBroker.Model.dll

Describes the identity of the user that initiated a request from the Platform.

public class OriginatingIdentity : IEquatable<OriginatingIdentity>

Inheritance

object

OriginatingIdentity

Implements

IEquatable<OriginatingIdentity>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

CompletableWithResult.Complete<TCompletable, TResult>(TCompletable, TResult?)

Constructors

OriginatingIdentity(string, JObject)

Describes the identity of the user that initiated a request from the Platform.

public OriginatingIdentity(string platform, JObject value)

Parameters

platform string

The Platform from which the request is being sent.

value JObject

A JSON object describing the user.

Fields

HttpHeaderName

The name of the HTTP header used to transmit this information.

public const string HttpHeaderName = "X-Broker-API-Originating-Identity"

Field Value

string

Properties

Platform

The Platform from which the request is being sent.

public string Platform { get; }

Property Value

string

Value

A JSON object describing the user.

public JObject Value { get; }

Property Value

JObject

Methods

Equals(OriginatingIdentity)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(OriginatingIdentity other)

Parameters

other OriginatingIdentity

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Parse(string)

Parses the originating identity object from its header string representation.

public static OriginatingIdentity Parse(string value)

Parameters

value string

Returns

OriginatingIdentity

ToString()

Serialized the originating identity object to its header string representation.

public override string ToString()

Returns

string

Operators

operator ==(OriginatingIdentity, OriginatingIdentity)

public static bool operator ==(OriginatingIdentity left, OriginatingIdentity right)

Parameters

left OriginatingIdentity

right OriginatingIdentity

Returns

bool

operator !=(OriginatingIdentity, OriginatingIdentity)

public static bool operator !=(OriginatingIdentity left, OriginatingIdentity right)

Parameters

left OriginatingIdentity

right OriginatingIdentity

Returns

bool