notifier

Documentation

Overview

Code generated by "admgencmd"; DO NOT EDIT. Source: declarativemanagement.yaml Options: no-shared=true,no-depend=true,no-responses=true

Package notifier notifies enrollments of changed declarations.

Index

• Constants
• func MakeCommand(uuid string, tokensJSON []byte) ([]byte, error)
• type DeclarativeManagementCommand
  • func NewDeclarativeManagementCommand(uuid string) *DeclarativeManagementCommand
• type DeclarativeManagementPayload
• type Enqueuer
• type EnrollmentIDFinder
• type Notifier
  • func New(enqueuer Enqueuer, store EnrollmentIDFinder, opts ...Option) (*Notifier, error)
  • func (n *Notifier) Changed(ctx context.Context, declarations []string, sets []string, idsIn []string) error
• type Option
  • func WithLogger(logger log.Logger) Option

Constants

const DeclarativeManagementRequestType = "DeclarativeManagement"

Functions

func MakeCommand

func MakeCommand(uuid string, tokensJSON []byte) ([]byte, error)

MakeCommand returns a raw MDM command in plist form using uuid and optionally tokensJSON.

Types

type DeclarativeManagementCommand

type DeclarativeManagementCommand struct {
	Command     DeclarativeManagementPayload
	CommandUUID string
}

DeclarativeManagementCommand is the top-level structure for the "DeclarativeManagement" Apple MDM command.

func NewDeclarativeManagementCommand

func NewDeclarativeManagementCommand(uuid string) *DeclarativeManagementCommand

NewDeclarativeManagementCommand creates a new "DeclarativeManagement" Apple MDM command.

type DeclarativeManagementPayload

type DeclarativeManagementPayload struct {
	Data                         *[]byte `plist:",omitempty"`
	RequestType                  string  // supported value: DeclarativeManagement
	RequestRequiresNetworkTether *bool   `plist:",omitempty"`
}

DeclarativeManagementPayload is the "inner" command-specific payload for the "DeclarativeManagement" Apple MDM command.

type Enqueuer

type Enqueuer interface {
	// EnqueueDMCommand enqueues a DeclarativeManagement command to ids optionally using tokensJSON.
	EnqueueDMCommand(ctx context.Context, ids []string, tokensJSON []byte) error
}

type EnrollmentIDFinder

type EnrollmentIDFinder interface {
	storage.TokensJSONRetriever
	storage.EnrollmentIDRetriever
}

EnrollmentIDFinder is the interface we use to fetch enrollment IDs.

type Notifier

type Notifier struct {
	// contains filtered or unexported fields
}

Notifier enqueues DM commands to enrollments based on changes.

func New

func New(enqueuer Enqueuer, store EnrollmentIDFinder, opts ...Option) (*Notifier, error)

func (*Notifier) Changed

func (n *Notifier) Changed(ctx context.Context, declarations []string, sets []string, idsIn []string) error

Change notifies (enqueues the DM command to) enrollments for which the changes apply to.

type Option

type Option func(n *Notifier)

func WithLogger

func WithLogger(logger log.Logger) Option