Unsubscribe Method

Unsubscribes the component from the specified topic.

procedure Unsubscribe(TopicId: String; TopicIdType: Integer);

Remarks

This method unsubscribes the component to the TopicId.

TopicIdType indicates the category of value specified in TopicId and may have the following values:

0: Topic name - a full topic name as described in RegisterTopic to be registered by the gateway.
1: Pre-defined topic id - id whose mapping to a topic name is known in advance by both the client and the gateway - no registration is necessary.
2: Short topic name - has a fixed length of two bytes and is short enough that no registration is necessary. To use one, simply set the correct TopicIdType and set the TopicId to a two-character string.

Unsubscribe Examples

String fullTopicName = "full/topic/name";
mqtt1.Unsubscribe(fullTopicName, 0); // unsubscribe from topic name
 
mqtt1.Unsubscribe(fullTopicName+"/#", 0); // must use full topic filter if includes wildcard; can't unsubscribe from individual topics included in the filter
 
mqtt1.Unsubscribe("aa", 2); // unsubscribe from short topic

IPWorks IoT 2020 Delphi Edition Website Download Support Questions / Feedback?
IPWorks IoT 2020 Delphi Edition Introduction Licensing Instructions AMQP Component Introduction Properties AuthScheme Connected ContainerId FetchTimeout Firewall IdleTimeout IncomingMessages (Collection) Links (Collection) LocalHost LocalPort Message OutgoingMessages (Collection) Password ReadyToSend ReceivedMessage ReceiveMode RemoteHost RemotePort Sessions (Collection) SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded Timeout User Methods CloseLink CloseSession Config Connect CreateReceiverLink CreateSenderLink CreateSession Disconnect DoEvents FetchMessage Interrupt Reset ResetMessage SendMessage Events Connected ConnectionStatus Disconnected Error LinkReadyToSend Log MessageIn MessageOut MessageOutcome SSLServerAuthentication SSLStatus Types AMQPLink AMQPMessage AMQPSession Firewall Configuration Error Codes AMQPClassic Component Introduction Properties Arguments (Collection) AuthScheme Channels (Collection) ClientProperties (Collection) Connected Firewall Heartbeat IncomingMessages (Collection) LocalHost LocalPort Message OutgoingMessages (Collection) Password QueueMessageCount ReceivedMessage RemoteHost RemotePort ServerProperties (Collection) SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded Timeout User VirtualHost Methods BindQueue CancelConsume CloseChannel CommitTransaction Config Connect Consume CreateChannel DeclareExchange DeclareQueue DeleteExchange DeleteQueue Disconnect DoEvents EnablePublishConfirms EnableTransactionMode FetchMessage Interrupt PublishMessage PurgeQueue Recover Reset ResetMessage RollbackTransaction SetChannelAccept SetQoS UnbindQueue Events ChannelReadyToSend Connected ConnectionStatus Disconnected Error Log MessageIn MessageOut MessageReturned SSLServerAuthentication SSLStatus Types AMQPCChannel AMQPCMessage AMQPCTableField Firewall Configuration Error Codes CoAP Component Introduction Properties Listening LocalHost LocalPort PendingRequests (Collection) RequestContentFormat RequestData RequestETag RequestOptions (Collection) ResponseCode ResponseContentFormat ResponseData ResponseETag ResponseOptions (Collection) Timeout UseConfirmableMessages Methods CancelRequest Config Delete DoEvents Get Post Put Reset SendCustomRequest SendNotification SendResponse StartObserving StopObserving Events Error Log Notification Register Request RequestComplete ResponseComplete Unregistered Types CoAPOption CoAPRequest Configuration Error Codes JSON Component Introduction Properties BuildDOM InputData InputFile OutputData OutputFile Overwrite Validate XChildren (Collection) XElement XElementType XErrorPath XParent XPath XSubTree XText Methods Config EndArray EndObject Flush HasXPath InsertProperty InsertValue LoadSchema Parse PutName PutProperty PutRaw PutValue Remove Reset Save SetInputStream SetElementName SetOutputStream SetValue StartArray StartObject TryXPath Events Characters EndDocument EndElement Error IgnorableWhitespace JSON StartDocument StartElement Types JSONElement Configuration Error Codes MQTT Component Introduction Properties CleanSession ClientId Connected Firewall IncomingMessages (Collection) KeepAliveInterval LocalHost LocalPort OutgoingMessages (Collection) Password ReadyToSend RemoteHost RemotePort SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded Timeout User Version WillMessage WillTopic Methods Config Connect Disconnect DoEvents Interrupt PublishData PublishMessage Reset RestoreSession SaveSession Subscribe Unsubscribe Events Connected ConnectionStatus Disconnected Error Log MessageAck MessageIn MessageOut ReadyToSend SSLServerAuthentication SSLStatus Subscribed Unsubscribed Types Firewall MQTTMessage Configuration Error Codes MQTTSN Component Introduction Properties CleanSession ClientId Connected KeepAliveInterval LocalHost LocalPort RemoteHost RemotePort Timeout WillMessage WillTopic Methods Config Connect Disconnect DiscoverGateway DoEvents FetchMessages Ping PublishData PublishMessage RegisterTopic Reset SendDiscoverResponse StartSleep StopSleep Subscribe Unsubscribe UpdateWillMessage UpdateWillTopic Events Connected Disconnected DiscoverRequest Error GatewayInfo Log MessageIn TopicInfo Configuration Error Codes STOMP Component Introduction Properties Connected ContentType Firewall Headers (Collection) IncomingHeartbeat LocalHost LocalPort OutgoingHeartbeat ParsedHeaders (Collection) Password ReadyToSend RemoteHost RemotePort RequestReceipts SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded Subscriptions (Collection) Timeout TransactionId User Methods AbortTransaction AddHeader BeginTransaction CommitTransaction Config Connect Disconnect DoEvents Interrupt Reset ResetHeaders SendData SendMessage Subscribe Unsubscribe Events Connected ConnectionStatus Disconnected Error Log MessageIn MessageOut ReadyToSend ReceiptIn ReceiptOut SSLServerAuthentication SSLStatus Subscribed Unsubscribed Types Firewall STOMPHeader STOMPSubscription Configuration Error Codes XMPP Component Introduction Properties AuthDomain AuthMethods Buddies (Collection) Connected Firewall IMPort IMServer LocalDirectory LocalFile LocalHost MessageHTML MessageOtherData MessageSubject MessageText MessageThread MessageType Password Presence Resource ServerDomain SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Status Timeout User UserDomain UserInfo (Collection) Methods Add Cancel ChangePassword ChangePresence Config Connect Disconnect DoEvents Interrupt ProbePresence QueryRegister Register Remove Reset RetrieveRoster SendCommand SendFile SendMessage SetUserInfoField SubscribeTo Unregister UnsubscribeTo Events BuddyUpdate Connected ConnectionStatus Disconnected EndTransfer Error IQ MessageIn PITrail Presence ReadyToSend SSLServerAuthentication SSLStatus StartTransfer SubscriptionRequest Sync Transfer Types Firewall XMPPBuddy XMPPUserInfo Configuration Error Codes Software License	Unsubscribe Method Unsubscribes the component from the specified topic. procedure Unsubscribe(TopicId: String; TopicIdType: Integer); Remarks This method unsubscribes the component to the TopicId. TopicIdType indicates the category of value specified in TopicId and may have the following values: `0`: Topic name - a full topic name as described in RegisterTopic to be registered by the gateway. `1`: Pre-defined topic id - id whose mapping to a topic name is known in advance by both the client and the gateway - no registration is necessary. `2`: Short topic name - has a fixed length of two bytes and is short enough that no registration is necessary. To use one, simply set the correct TopicIdType and set the TopicId to a two-character string. Unsubscribe Examples view source `String fullTopicName =` `"full/topic/name";` `mqtt1.Unsubscribe(fullTopicName, 0);` `// unsubscribe from topic name` `mqtt1.Unsubscribe(fullTopicName+"/#", 0);` `// must use full topic filter if includes wildcard; can't unsubscribe from individual topics included in the filter` `mqtt1.Unsubscribe("aa", 2);` `// unsubscribe from short topic`
Copyright (c) 2022 /n software inc. - All rights reserved. IPWorks IoT 2020 Delphi Edition - Version 20.0 [Build 8265]

IPWorks IoT 2020 Delphi Edition

Unsubscribe Method

Remarks

Questions / Feedback?