MessageCallbackProps

Properties for defining a MessageCallback.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vod-messagecallback

Initializer

import { MessageCallbackProps } from '@alicloud/ros-cdk-vod'
const messageCallbackProps: MessageCallbackProps = { ... }

Properties

Name	Type	Description
callbackType	string | @alicloud/ros-cdk-core.IResolvable	Property callbackType: Callback method.
appId	string | @alicloud/ros-cdk-core.IResolvable	Property appId: App ID.
authKey	string | @alicloud/ros-cdk-core.IResolvable	Property authKey: Authentication Key, up to 32 characters, must contain both uppercase and lowercase letters and numbers.
authSwitch	string | @alicloud/ros-cdk-core.IResolvable	Property authSwitch: The authentication switch of the HTTP callback, this parameter is valid when the callback method is set to HTTP.
callbackUrl	string | @alicloud/ros-cdk-core.IResolvable	Property callbackUrl: Callback address.
eventTypeList	string | @alicloud/ros-cdk-core.IResolvable	Property eventTypeList: Callback event type.
mnsEndpoint	string | @alicloud/ros-cdk-core.IResolvable	Property mnsEndpoint: This parameter needs to be set when the callback method is MNS for the message queue public network endpoint.
mnsQueueName	string | @alicloud/ros-cdk-core.IResolvable	Property mnsQueueName: The name of the message queue, which can be viewed in the queue list by logging in to the message service console.

---

callbackType^Required

public readonly callbackType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property callbackType: Callback method.

---

appId^Optional

public readonly appId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property appId: App ID.

If it is not passed, it is the ID of the default application of the system, with a fixed value: app-1000000.

---

authKey^Optional

public readonly authKey: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property authKey: Authentication Key, up to 32 characters, must contain both uppercase and lowercase letters and numbers.

This parameter can be set when the callback method is HTTP.

---

authSwitch^Optional

public readonly authSwitch: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property authSwitch: The authentication switch of the HTTP callback, this parameter is valid when the callback method is set to HTTP.

---

callbackUrl^Optional

public readonly callbackUrl: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property callbackUrl: Callback address.

When the callback method is HTTP, this parameter needs to be set. The length of the callback address URL cannot exceed 256 bytes, and setting multiple callback addresses is not supported.

---

eventTypeList^Optional

public readonly eventTypeList: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property eventTypeList: Callback event type.

When the value is empty, all message notifications are turned off, and when the value is ALL, all message notifications are turned on. You can also specify to enable certain message notifications, and use a comma (,) to separate multiple event types.

---

mnsEndpoint^Optional

public readonly mnsEndpoint: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property mnsEndpoint: This parameter needs to be set when the callback method is MNS for the message queue public network endpoint.

You can log in to the message service console and click the Get Endpoint button in the upper right corner to get it.

---

mnsQueueName^Optional

public readonly mnsQueueName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property mnsQueueName: The name of the message queue, which can be viewed in the queue list by logging in to the message service console.

When the callback method is MNS, this parameter needs to be set.

---