Dispatch buckets

Manage dispatch membership in buckets

General bucket management

These functions can create and then add/remove dispatches from buckets. The other functions are built on these.

AddDispatchToBucket

    core.AddDispatchToBucket({bucketId="..", dispatchId=".."})

DescriptionParametersReturn value

Add a dispatch to a bucket.

• bucketId: bucket id
• dispatchId: dispatch to add

• Boolean

RemoveDispatchFromBucket

    core.RemoveDispatchFromBucket({bucketId="..", dispatchId=".."})

DescriptionParametersReturn value

Remove a dispatch from a bucket.

• bucketId: bucket id
• dispatchId: dispatch to add

• Boolean

User buckets

AddUserBucketDispatch

    core.AddUserBucketDispatch({ownerId="..", dispatchId="..", handle=".."})

DescriptionParametersReturn value

Add a dispatch to a user bucket identified by handle.

• ownerId: user owner of the bucket
• dispatchId: dispatch to add
• handle: handle of the bucket

• Boolean

RemoveUserBucketDispatch

    core.RemoveUserBucketDispatch({ownerId="..", dispatchId=".."})

DescriptionParametersReturn value

Remove a dispatch from a user bucket identified by the owner.

• ownerId: user owner of the bucket
• dispatchId: dispatch to add

• Boolean

Dispatch buckets

AddDispatchBucketDispatch

    core.AddDispatchBucketDispatch({ownerId="..", dispatchId=".."})

DescriptionParametersReturn value

Add a dispatch to a dispatch bucket identified by the owner.

• ownerId: dispatch owner of the bucket
• dispatchId: dispatch to add

• Boolean

RemoveDispatchBucketDispatch

    core.RemoveDispatchBucketDispatch({ownerId="..", dispatchId=".."})

DescriptionParametersReturn value

Remove a dispatch from a dispatch bucket identified by the owner.

• ownerId: dispatch owner of the bucket
• dispatchId: dispatch to add

• Boolean

UserBucketLookup

    core.UserBucketLookup({ownerId="..", handle=".."})

DescriptionParametersReturn value

Lookup the bucket id for a user bucket by handle; this will create the bucket if it does not already exist

• ownerId: user owner of the bucket
• handle: bucket handle

• UUID

VerifyBucketEntity

    core.VerifyBucketEntity({entityId="..", kind="..", handle=".."})

DescriptionParametersReturn value

Create or verify a bucket exists

• entityId: user owner of the bucket
• kind: org | user | dispatch | group ..
• handle: optional handle for the bucket; each handle creates a unique bucket

• id for the bucket