UserMetadata
in package
uses
CloneWith
FinalYes
Information a user can set, often for use by user interfaces.
Tags
Table of Contents
Properties
- $details : string
- 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.
- $summary : string
- 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.
Methods
- __construct() : mixed
- withDetails() : self
- withSummary() : self
Properties
$details read-only
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
string
$details
$summary read-only
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
string
$summary
Methods
__construct()
public
__construct(string $summary, string $details) : mixed
Parameters
- $summary : string
- $details : string
withDetails()
public
withDetails(string $details) : self
Parameters
- $details : string
Return values
selfwithSummary()
public
withSummary(string $summary) : self
Parameters
- $summary : string