Interface DialMembershipService

dial_membership.go:65–89

DialMembershipService represents a service for managing dial memberships.

// DialMembershipService represents a service for managing dial memberships.
type DialMembershipService interface {
	// Retrieves a membership by ID along with the associated dial & user.
	// Returns ENOTFOUND if membership does exist or user does not have
	// permission to view it.
	FindDialMembershipByID(ctx context.Context, id int) (*DialMembership, error)

	// Retrieves a list of matching memberships based on filter. Only returns
	// memberships that belong to dials that the current user is a member of.
	// Also returns a count of total matching memberships which may different if
	// "Limit" is specified on the filter.
	FindDialMemberships(ctx context.Context, filter DialMembershipFilter) ([]*DialMembership, int, error)

	// Creates a new membership on a dial for the current user. Returns
	// EUNAUTHORIZED if there is no current user logged in.
	CreateDialMembership(ctx context.Context, membership *DialMembership) error

	// Updates the value of a membership. Only the owner of the membership can
	// update the value. Returns EUNAUTHORIZED if user is not the owner. Returns
	// ENOTFOUND if the membership does not exist.
	UpdateDialMembership(ctx context.Context, id int, upd DialMembershipUpdate) (*DialMembership, error)

	// Permanently deletes a membership by ID. Only the membership owner and
	// the parent dial's owner can delete a membership.
	DeleteDialMembership(ctx context.Context, id int) error
}

// Dial membership sort options. Only specific sorting options are supported.
const (