Class: PatchedMarkerData
coresdk.external_data.PatchedMarkerData
Represents a PatchedMarkerData.
Implements
Constructors
constructor
• new PatchedMarkerData(properties?): PatchedMarkerData
Constructs a new PatchedMarkerData.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPatchedMarkerData | Properties to set |
Returns
Properties
deprecated
• deprecated: boolean
Whether or not the patch is marked deprecated.
Implementation of
id
• id: string
The patch id
Implementation of
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
| Name | Type | Description |
|---|---|---|
properties? | IPatchedMarkerData | Properties to set |
Returns
PatchedMarkerData instance
decode
▸ decode(reader, length?): PatchedMarkerData
Decodes a PatchedMarkerData message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IPatchedMarkerData | PatchedMarkerData message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IPatchedMarkerData | PatchedMarkerData message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PatchedMarkerData
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PatchedMarkerData
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your 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
| Name | Type | Description |
|---|---|---|
message | PatchedMarkerData | PatchedMarkerData |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object