Represents a CallAnnotation.
Package
@google-cloud/contact-center-insightsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.contactcenterinsights.v1.ICallAnnotation);Constructs a new CallAnnotation.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICallAnnotation
Properties to set |
Properties
annotationEndBoundary
public annotationEndBoundary?: (google.cloud.contactcenterinsights.v1.IAnnotationBoundary|null);CallAnnotation annotationEndBoundary.
annotationStartBoundary
public annotationStartBoundary?: (google.cloud.contactcenterinsights.v1.IAnnotationBoundary|null);CallAnnotation annotationStartBoundary.
channelTag
public channelTag: number;CallAnnotation channelTag.
data
public data?: ("interruptionData"|"sentimentData"|"silenceData"|"holdData"|"entityMentionData"|"intentMatchData"|"phraseMatchData"|"issueMatchData");CallAnnotation data.
entityMentionData
public entityMentionData?: (google.cloud.contactcenterinsights.v1.IEntityMentionData|null);CallAnnotation entityMentionData.
holdData
public holdData?: (google.cloud.contactcenterinsights.v1.IHoldData|null);CallAnnotation holdData.
intentMatchData
public intentMatchData?: (google.cloud.contactcenterinsights.v1.IIntentMatchData|null);CallAnnotation intentMatchData.
interruptionData
public interruptionData?: (google.cloud.contactcenterinsights.v1.IInterruptionData|null);CallAnnotation interruptionData.
issueMatchData
public issueMatchData?: (google.cloud.contactcenterinsights.v1.IIssueMatchData|null);CallAnnotation issueMatchData.
phraseMatchData
public phraseMatchData?: (google.cloud.contactcenterinsights.v1.IPhraseMatchData|null);CallAnnotation phraseMatchData.
sentimentData
public sentimentData?: (google.cloud.contactcenterinsights.v1.ISentimentData|null);CallAnnotation sentimentData.
silenceData
public silenceData?: (google.cloud.contactcenterinsights.v1.ISilenceData|null);CallAnnotation silenceData.
Methods
create(properties)
public static create(properties?: google.cloud.contactcenterinsights.v1.ICallAnnotation): google.cloud.contactcenterinsights.v1.CallAnnotation;Creates a new CallAnnotation instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICallAnnotation
Properties to set |
| Returns | |
|---|---|
| Type | Description |
CallAnnotation | CallAnnotation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contactcenterinsights.v1.CallAnnotation;Decodes a CallAnnotation message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
CallAnnotation | CallAnnotation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contactcenterinsights.v1.CallAnnotation;Decodes a CallAnnotation message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
CallAnnotation | CallAnnotation |
encode(message, writer)
public static encode(message: google.cloud.contactcenterinsights.v1.ICallAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CallAnnotation message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICallAnnotation
CallAnnotation message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.contactcenterinsights.v1.ICallAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified CallAnnotation message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICallAnnotation
CallAnnotation message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.contactcenterinsights.v1.CallAnnotation;Creates a CallAnnotation message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
CallAnnotation | CallAnnotation |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for CallAnnotation
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this CallAnnotation to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.contactcenterinsights.v1.CallAnnotation, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a CallAnnotation message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
CallAnnotation
CallAnnotation |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a CallAnnotation message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|