(DataFlex) Azure Service Bus - Delete Message

See more Azure Service Bus Examples

Deletes a message from a queue or subscription.

For more information, see https://docs.microsoft.com/en-us/rest/api/servicebus/unlock-message

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoRest
    Boolean iBAutoReconnect
    Boolean iSuccess
    Handle hoSbToken
    String sTopicName
    String sSubscriptionName
    String sMessageId
    String sLockToken
    Handle hoSbPath
    Integer iNumReplaced
    Variant vSbResponseBody
    Handle hoSbResponseBody
    String sTemp1
    Integer iTemp1

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // Make the initial connection.
    // A single REST object, once connected, can be used for many Azure Service Bus REST API calls.
    // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
    // then it will be automatically re-established as needed.
    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "<yournamespace>.servicebus.windows.net" 443 True iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Let's load a previously computed SAS token and use it.
    // See Azure Shared Access Signature for an example to genenerate an Azure SAS token.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbToken
    If (Not(IsComObjectCreated(hoSbToken))) Begin
        Send CreateComObject of hoSbToken
    End
    Get ComLoadFile Of hoSbToken "qa_data/tokens/serviceBusSas.txt" "utf-8" To iSuccess

    // Tell the REST object to use the Azure Shared Access Signature for authorization.
    Get ComPrepend Of hoSbToken "SharedAccessSignature " To iSuccess
    Get ComGetAsString Of hoSbToken To sTemp1
    Get ComAddHeader Of hoRest "Authorization" sTemp1 To iSuccess

    // ----------------------------------------------------------------------------------------------
    // The code above this comment could be placed inside a function/subroutine within the application
    // because the connection does not need to be made for every request.  Once the connection is made
    // the app may send many requests..
    // ----------------------------------------------------------------------------------------------

    // To delete a message, we'll need either the SequenceNumber or MessageId.
    // When the message was peek-locked, the SequenceNumber and MessageId of the locked message
    // was returned in the HTTP response header named "BrokerProperties, which contained
    // JSON such as the following:
    // 
    // 	{
    // 	  "DeliveryCount": 1,
    // 	  "EnqueuedSequenceNumber": 3000004,
    // 	  "EnqueuedTimeUtc": "Wed, 07 Dec 2016 17:42:48 GMT",
    // 	  "Label": "M3",
    // 	  "LockToken": "6eeee205-e541-4cb6-95fb-4c81da5f6858",
    // 	  "LockedUntilUtc": "Thu, 08 Dec 2016 00:57:32 GMT",
    // 	  "MessageId": "e8028116d63c43f191577f2789b1cca7",
    // 	  "SequenceNumber": 4,
    // 	  "State": "Active",
    // 	  "TimeToLive": 922337193600
    // 	}
    // 
    // 
    // The path for unlocking a message is constructed as follows, depending on
    // whether it is a message on a queue or subscription:
    // 
    // (for a queue)
    // /{queuePath}/messages/{messageId|sequenceNumber}/{lockToken}
    // 
    // (for a subscription)
    // /{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}

    // This example will build a path to delete a message contained in a subscription.
    Move "gilaMonster" To sTopicName
    Move "feedings" To sSubscriptionName
    Move "e8028116d63c43f191577f2789b1cca7" To sMessageId
    Move "6eeee205-e541-4cb6-95fb-4c81da5f6858" To sLockToken

    // Build the path..
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPath
    If (Not(IsComObjectCreated(hoSbPath))) Begin
        Send CreateComObject of hoSbPath
    End
    Get ComAppend Of hoSbPath "/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}" To iSuccess
    Get ComReplace Of hoSbPath "{topicPath}" sTopicName To iNumReplaced
    Get ComReplace Of hoSbPath "{subscriptionName}" sSubscriptionName To iNumReplaced
    Get ComReplace Of hoSbPath "{messageId|sequenceNumber}" sMessageId To iNumReplaced
    Get ComReplace Of hoSbPath "{lockToken}" sLockToken To iNumReplaced

    // Add a timeout parameter.
    Get ComAddQueryParam Of hoRest "timeout" "20" To iSuccess

    // Use the DELETE HTTP verb to delete the message.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get ComGetAsString Of hoSbPath To sTemp1
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComFullRequestNoBodySb Of hoRest "DELETE" sTemp1 vSbResponseBody To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComResponseStatusCode Of hoRest To iTemp1
    Showln "Response Status Code = " iTemp1

    // Check for a success response.
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 200) Begin
        Get ComLastRequestStartLine Of hoRest To sTemp1
        Showln sTemp1
        Get ComLastRequestHeader Of hoRest To sTemp1
        Showln sTemp1
        Get ComGetAsString Of hoSbResponseBody To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

    // If successful, the response body would be empty..
    Showln "Success."


End_Procedure