Class: InteractiveAnnotation

Defined in: WAProto/index.d.ts:16662

Represents an InteractiveAnnotation.

Implements

• IInteractiveAnnotation

Constructors

new InteractiveAnnotation()

new InteractiveAnnotation(properties?): InteractiveAnnotation

Defined in: WAProto/index.d.ts:16668

Constructs a new InteractiveAnnotation.

Parameters

properties?

IInteractiveAnnotation

Properties to set

Returns

InteractiveAnnotation

Properties

action?

optional action: "location" | "newsletter" | "embeddedAction" | "tapAction"

Defined in: WAProto/index.d.ts:16695

InteractiveAnnotation action.

---

embeddedAction?

optional embeddedAction: null | boolean

Defined in: WAProto/index.d.ts:16689

InteractiveAnnotation embeddedAction.

Implementation of

IInteractiveAnnotation.embeddedAction

---

embeddedContent?

optional embeddedContent: null | IEmbeddedContent

Defined in: WAProto/index.d.ts:16677

InteractiveAnnotation embeddedContent.

Implementation of

IInteractiveAnnotation.embeddedContent

---

location?

optional location: null | ILocation

Defined in: WAProto/index.d.ts:16683

InteractiveAnnotation location.

Implementation of

IInteractiveAnnotation.location

---

newsletter?

optional newsletter: null | IForwardedNewsletterMessageInfo

Defined in: WAProto/index.d.ts:16686

InteractiveAnnotation newsletter.

Implementation of

IInteractiveAnnotation.newsletter

---

polygonVertices

polygonVertices: IPoint[]

Defined in: WAProto/index.d.ts:16671

InteractiveAnnotation polygonVertices.

Implementation of

IInteractiveAnnotation.polygonVertices

---

shouldSkipConfirmation?

optional shouldSkipConfirmation: null | boolean

Defined in: WAProto/index.d.ts:16674

InteractiveAnnotation shouldSkipConfirmation.

Implementation of

IInteractiveAnnotation.shouldSkipConfirmation

---

statusLinkType?

optional statusLinkType: null | StatusLinkType

Defined in: WAProto/index.d.ts:16680

InteractiveAnnotation statusLinkType.

Implementation of

IInteractiveAnnotation.statusLinkType

---

tapAction?

optional tapAction: null | ITapLinkAction

Defined in: WAProto/index.d.ts:16692

InteractiveAnnotation tapAction.

Implementation of

IInteractiveAnnotation.tapAction

Methods

toJSON()

toJSON(): object

Defined in: WAProto/index.d.ts:16765

Converts this InteractiveAnnotation to JSON.

Returns

object

JSON object

---

create()

static create(properties?): InteractiveAnnotation

Defined in: WAProto/index.d.ts:16702

Creates a new InteractiveAnnotation instance using the specified properties.

Parameters

properties?

IInteractiveAnnotation

Properties to set

Returns

InteractiveAnnotation

InteractiveAnnotation instance

---

decode()

static decode(reader, length?): InteractiveAnnotation

Defined in: WAProto/index.d.ts:16728

Decodes an InteractiveAnnotation message from the specified reader or buffer.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?

number

Message length if known beforehand

Returns

InteractiveAnnotation

InteractiveAnnotation

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): InteractiveAnnotation

Defined in: WAProto/index.d.ts:16737

Decodes an InteractiveAnnotation message from the specified reader or buffer, length delimited.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

InteractiveAnnotation

InteractiveAnnotation

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:16710

Encodes the specified InteractiveAnnotation message. Does not implicitly verify messages.

Parameters

message

IInteractiveAnnotation

InteractiveAnnotation message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:16718

Encodes the specified InteractiveAnnotation message, length delimited. Does not implicitly verify messages.

Parameters

message

IInteractiveAnnotation

InteractiveAnnotation message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): InteractiveAnnotation

Defined in: WAProto/index.d.ts:16751

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

Parameters

object

Plain object

Returns

InteractiveAnnotation

InteractiveAnnotation

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:16772

Gets the default type url for InteractiveAnnotation

Parameters

typeUrlPrefix?

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject()

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:16759

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

Parameters

message

InteractiveAnnotation

InteractiveAnnotation

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

Defined in: WAProto/index.d.ts:16744

Verifies an InteractiveAnnotation message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not