Class UserMetadata

Namespace

Temporalio.Api.Sdk.V1

Assembly

Temporalio.dll

Information a user can set, often for use by user interfaces.

public sealed class UserMetadata : IMessage<UserMetadata>, IEquatable<UserMetadata>, IDeepCloneable<UserMetadata>, IBufferMessage, IMessage

Inheritance

object

UserMetadata

Implements

IMessage<UserMetadata>

IEquatable<UserMetadata>

IDeepCloneable<UserMetadata>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

UserMetadata()

public UserMetadata()

UserMetadata(UserMetadata)

public UserMetadata(UserMetadata other)

Parameters

other UserMetadata

Fields

DetailsFieldNumber

Field number for the "details" field.

public const int DetailsFieldNumber = 2

Field Value

int

SummaryFieldNumber

Field number for the "summary" field.

public const int SummaryFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Details

Long-form text that provides details. This payload should be a "json/plain"-encoded payload that is a single JSON string for use in user interfaces. User interface formatting may apply to this text in common use. The payload data section is limited to 20000 bytes by default.

public Payload Details { get; set; }

Property Value

Payload

Parser

public static MessageParser<UserMetadata> Parser { get; }

Property Value

MessageParser<UserMetadata>

Summary

Short-form text that provides a summary. This payload should be a "json/plain"-encoded payload that is a single JSON string for use in user interfaces. User interface formatting may not apply to this text when used in "title" situations. The payload data section is limited to 400 bytes by default.

public Payload Summary { get; set; }

Property Value

Payload

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public UserMetadata Clone()

Returns

UserMetadata

A deep clone of this object.

Equals(object)

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

public override bool Equals(object other)

Parameters

other object

Returns

bool

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

Equals(UserMetadata)

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

public bool Equals(UserMetadata other)

Parameters

other UserMetadata

An object to compare with this object.

Returns

bool

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

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(UserMetadata)

Merges the given message into this one.

public void MergeFrom(UserMetadata other)

Parameters

other UserMetadata

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.