TopicTypes interface
Interface representing a TopicTypes.
Methods
get(string, Topic |
Get information about a topic type. |
list(Topic |
List all registered topic types. |
list |
List event types for a topic type. |
Method Details
get(string, TopicTypesGetOptionalParams)
Get information about a topic type.
function get(topicTypeName: string, options?: TopicTypesGetOptionalParams): Promise<TopicTypeInfo>
Parameters
- topicTypeName
-
string
Name of the topic type.
- options
- TopicTypesGetOptionalParams
The options parameters.
Returns
Promise<TopicTypeInfo>
list(TopicTypesListOptionalParams)
List all registered topic types.
function list(options?: TopicTypesListOptionalParams): PagedAsyncIterableIterator<TopicTypeInfo, TopicTypeInfo[], PageSettings>
Parameters
- options
- TopicTypesListOptionalParams
The options parameters.
Returns
listEventTypes(string, TopicTypesListEventTypesOptionalParams)
List event types for a topic type.
function listEventTypes(topicTypeName: string, options?: TopicTypesListEventTypesOptionalParams): PagedAsyncIterableIterator<EventType, EventType[], PageSettings>
Parameters
- topicTypeName
-
string
Name of the topic type.
The options parameters.