extension_pubsub.go

package helix

// PublishType The Pub/Sub broadcast type
type ExtensionPubSubPublishType string

// Types of Pub/Sub Permissions or targets
const (
	ExtensionPubSubGenericPublish   ExtensionPubSubPublishType = "*"
	ExtensionPubSubBroadcastPublish ExtensionPubSubPublishType = "broadcast"
	ExtensionPubSubGlobalPublish    ExtensionPubSubPublishType = "global"
)

func (p ExtensionPubSubPublishType) String() string {
	return string(p)
}

func (c *Client) createExtensionPubSubWhisper(opaqueId string) ExtensionPubSubPublishType {
	return ExtensionPubSubPublishType("whisper-" + opaqueId)
}

// FormWhisperSendPubSubPermissions create the pubsub permissions
// for publishing a whisper message type
func (c *Client) FormWhisperSendPubSubPermissions(opaqueId string) *PubSubPermissions {
	return &PubSubPermissions{
		Send: []ExtensionPubSubPublishType{c.createExtensionPubSubWhisper(opaqueId)},
	}
}

// FormBroadcastSendPubSubPermissions create the pubsub permissions
// for publishing a broadcast message type
func (c *Client) FormBroadcastSendPubSubPermissions() *PubSubPermissions {
	return &PubSubPermissions{
		Send: []ExtensionPubSubPublishType{ExtensionPubSubBroadcastPublish},
	}
}

// FormGlobalSendPubSubPermissions create the pubsub permissions
// for publishing a global targeted message
func (c *Client) FormGlobalSendPubSubPermissions() *PubSubPermissions {
	return &PubSubPermissions{
		Send: []ExtensionPubSubPublishType{ExtensionPubSubGlobalPublish},
	}
}

// FormGenericPubSubPermissions create the pubsub permissions
// for publishing to message for any target type
func (c *Client) FormGenericPubSubPermissions() *PubSubPermissions {
	return &PubSubPermissions{
		Send: []ExtensionPubSubPublishType{ExtensionPubSubGenericPublish},
	}
}

type ExtensionSendPubSubMessageParams struct {
	BroadcasterID     string                       `json:"broadcaster_id"`
	Message           string                       `json:"message"`
	Target            []ExtensionPubSubPublishType `json:"target"`
	IsGlobalBroadcast bool                         `json:"is_global_broadcast"`
}

type ExtensionSendPubSubMessageResponse struct {
	ResponseCommon
}

func (c *Client) SendExtensionPubSubMessage(params *ExtensionSendPubSubMessageParams) (*ExtensionSendPubSubMessageResponse, error) {
	resp, err := c.postAsJSON("/extensions/pubsub", &ExtensionSendPubSubMessageResponse{}, params)
	if err != nil {
		return nil, err
	}

	sndExtPubSubMsgRsp := &ExtensionSendPubSubMessageResponse{}
	resp.HydrateResponseCommon(&sndExtPubSubMsgRsp.ResponseCommon)

	return sndExtPubSubMsgRsp, nil
}