Class CreateSketchAttachmentRequest

Represents a request to create a new Sketch attachment for annotation

Inheritance
object
CreateSketchAttachmentRequest
Implements
Inherited Members
Namespace: Unity.Cloud.Collaboration.Models.AttachmentRequest
Assembly: Unity.Cloud.Collaboration.dll
Syntax
public class CreateSketchAttachmentRequest : ICreateSketchAttachmentRequest, ICreateAttachmentRequest

Constructors

CreateSketchAttachmentRequest(string, ICameraDetails, TimeDetails?, IRequestFileDetails, IRequestFileDetails, Dictionary<string, object>)

Represents a request to create a new sketch attachment, including associated metadata, camera details, sketch data, and optional preview and sketch image details.

Declaration
public CreateSketchAttachmentRequest(string sketchData, ICameraDetails camera, TimeDetails? time = null, IRequestFileDetails preview = null, IRequestFileDetails sketchImage = null, Dictionary<string, object> metadata = null)
Parameters
Type Name Description
string sketchData

The raw data representing the sketch to attach.
ICameraDetails camera

Details about the camera used for the sketch.
TimeDetails? time

Optional time details associated with the sketch.
IRequestFileDetails preview

Optional preview image file details for the sketch.
IRequestFileDetails sketchImage

Optional full sketch image file details.
Dictionary<string, object> metadata

Optional metadata associated with the sketch attachment.
Exceptions
Type Condition
ArgumentNullException

Thrown when required parameters are null or empty.

Properties

Camera

Camera data structure.

Declaration
public ICameraDetails Camera { get; }
Property Value
Type Description
ICameraDetails

Metadata

Metadata for the Attachment

Declaration
public Dictionary<string, object> Metadata { get; }
Property Value
Type Description
Dictionary<string, object>

Preview

File data for sketch attachment

Declaration
public IRequestFileDetails Preview { get; }
Property Value
Type Description
IRequestFileDetails

SketchData

The JSON data of the sketch.

Declaration
public string SketchData { get; }
Property Value
Type Description
string

SketchImage

File data for sketch attachment

Declaration
public IRequestFileDetails SketchImage { get; }
Property Value
Type Description
IRequestFileDetails

Time

Time data structure.

Declaration
public TimeDetails? Time { get; }
Property Value
Type Description
TimeDetails?

Type

The type of the Attachment, this should be used to identify the specific type of Attachment given

Declaration
public string Type { get; }
Property Value
Type Description
string

Implements