AwsIotJobs_RemovePersistentSubscriptions

Remove persistent Jobs operation topic subscriptions.

AwsIotJobsError_t AwsIotJobs_RemovePersistentSubscriptions( const AwsIotJobsRequestInfo_t * pRequestInfo,
                                                            uint32_t flags );

Passing the flag AWS_IOT_JOBS_FLAG_KEEP_SUBSCRIPTIONS to AwsIotJobs_GetPendingAsync, AwsIotJobs_StartNextAsync, AwsIotJobs_DescribeAsync, AwsIotJobs_UpdateAsync, or their blocking versions causes the Jobs operation topic subscriptions to be maintained for future calls to the same function. If a persistent subscription for a Jobs topic are no longer needed, this function may be used to remove it.

Parameters

[in]	pRequestInfo	Jobs request info. Only the pThingName, thingNameLength, and mqttConnection members need to be set for this function.
[in]	flags	Flags that determine which subscriptions to remove. Valid values are the bitwise OR of the following individual flags: AWS_IOT_JOBS_FLAG_REMOVE_GET_PENDING_SUBSCRIPTIONS AWS_IOT_JOBS_FLAG_REMOVE_START_NEXT_SUBSCRIPTIONS AWS_IOT_JOBS_FLAG_REMOVE_DESCRIBE_SUBSCRIPTIONS AWS_IOT_JOBS_FLAG_REMOVE_UPDATE_SUBSCRIPTIONS

Returns

On success:

• AWS_IOT_JOBS_SUCCESS

If an MQTT UNSUBSCRIBE packet cannot be sent, one of the following:

• AWS_IOT_JOBS_NO_MEMORY
• AWS_IOT_JOBS_MQTT_ERROR

Note

AwsIotJobs_Cleanup removes persistent sessions as well.

Warning

This function is not safe to call with any in-progress operations! It also does not affect NOTIFY PENDING and NOTIFY NEXT callbacks registered with AwsIotJobs_SetNotifyPendingCallback and AwsIotJobs_SetNotifyNextCallback, respectively. (See documentation for those functions on how to remove their callbacks).