CallAnnotation

google.cloud.contactcenterinsights.v1. CallAnnotation

Represents a CallAnnotation.

Constructor

new CallAnnotation(propertiesopt)

Constructs a new CallAnnotation.

Parameters:
Name Type Attributes Description
properties google.cloud.contactcenterinsights.v1.ICallAnnotation <optional>

Properties to set

Implements:
  • ICallAnnotation

Members

annotationEndBoundary

CallAnnotation annotationEndBoundary.

annotationStartBoundary

CallAnnotation annotationStartBoundary.

channelTag

CallAnnotation channelTag.

data

CallAnnotation data.

entityMentionData

CallAnnotation entityMentionData.

holdData

CallAnnotation holdData.

intentMatchData

CallAnnotation intentMatchData.

interruptionData

CallAnnotation interruptionData.

issueMatchData

CallAnnotation issueMatchData.

phraseMatchData

CallAnnotation phraseMatchData.

sentimentData

CallAnnotation sentimentData.

silenceData

CallAnnotation silenceData.

Methods

toJSON() → {Object.<string, *>}

Converts this CallAnnotation to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.contactcenterinsights.v1.CallAnnotation}

Creates a new CallAnnotation instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.contactcenterinsights.v1.ICallAnnotation <optional>

Properties to set

Returns:
Type Description
google.cloud.contactcenterinsights.v1.CallAnnotation

CallAnnotation instance

(static) decode(reader, lengthopt) → {google.cloud.contactcenterinsights.v1.CallAnnotation}

Decodes a CallAnnotation message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.contactcenterinsights.v1.CallAnnotation

CallAnnotation

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.contactcenterinsights.v1.CallAnnotation}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.contactcenterinsights.v1.CallAnnotation

CallAnnotation

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.contactcenterinsights.v1.ICallAnnotation

CallAnnotation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.contactcenterinsights.v1.ICallAnnotation

CallAnnotation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.contactcenterinsights.v1.CallAnnotation}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.contactcenterinsights.v1.CallAnnotation

CallAnnotation

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for CallAnnotation

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.contactcenterinsights.v1.CallAnnotation

CallAnnotation

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a CallAnnotation message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not