Skip to main content

Class: PatchedMarkerData

coresdk.external_data.PatchedMarkerData

Represents a PatchedMarkerData.

Implements

Constructors

constructor

new PatchedMarkerData(properties?): PatchedMarkerData

Constructs a new PatchedMarkerData.

Parameters

NameTypeDescription
properties?IPatchedMarkerDataProperties to set

Returns

PatchedMarkerData

Properties

deprecated

deprecated: boolean

Whether or not the patch is marked deprecated.

Implementation of

IPatchedMarkerData.deprecated


id

id: string

The patch id

Implementation of

IPatchedMarkerData.id

Methods

toJSON

toJSON(): Object

Converts this PatchedMarkerData to JSON.

Returns

Object

JSON object


create

create(properties?): PatchedMarkerData

Creates a new PatchedMarkerData instance using the specified properties.

Parameters

NameTypeDescription
properties?IPatchedMarkerDataProperties to set

Returns

PatchedMarkerData

PatchedMarkerData instance


decode

decode(reader, length?): PatchedMarkerData

Decodes a PatchedMarkerData message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

PatchedMarkerData

PatchedMarkerData

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): PatchedMarkerData

Decodes a PatchedMarkerData message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

PatchedMarkerData

PatchedMarkerData

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified PatchedMarkerData message. Does not implicitly coresdk.external_data.PatchedMarkerData.verify|verify messages.

Parameters

NameTypeDescription
messageIPatchedMarkerDataPatchedMarkerData message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified PatchedMarkerData message, length delimited. Does not implicitly coresdk.external_data.PatchedMarkerData.verify|verify messages.

Parameters

NameTypeDescription
messageIPatchedMarkerDataPatchedMarkerData message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): PatchedMarkerData

Creates a PatchedMarkerData message from a plain object. Also converts values to their respective internal types.

Parameters

NameTypeDescription
objectObjectPlain object

Returns

PatchedMarkerData

PatchedMarkerData


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PatchedMarkerData

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

Creates a plain object from a PatchedMarkerData message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messagePatchedMarkerDataPatchedMarkerData
options?IConversionOptionsConversion options

Returns

Object

Plain object