teammembership

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) Create(membership *portainer.TeamMembership) error
  • func (service *Service) DeleteTeamMembership(ID portainer.TeamMembershipID) error
  • func (service *Service) DeleteTeamMembershipByTeamID(teamID portainer.TeamID) error
  • func (service *Service) DeleteTeamMembershipByTeamIDAndUserID(teamID portainer.TeamID, userID portainer.UserID) error
  • func (service *Service) DeleteTeamMembershipByUserID(userID portainer.UserID) error
  • func (service *Service) TeamMembership(ID portainer.TeamMembershipID) (*portainer.TeamMembership, error)
  • func (service *Service) TeamMemberships() ([]portainer.TeamMembership, error)
  • func (service *Service) TeamMembershipsByTeamID(teamID portainer.TeamID) ([]portainer.TeamMembership, error)
  • func (service *Service) TeamMembershipsByUserID(userID portainer.UserID) ([]portainer.TeamMembership, error)
  • func (service *Service) UpdateTeamMembership(ID portainer.TeamMembershipID, membership *portainer.TeamMembership) error

Constants

const (
	// BucketName represents the name of the bucket where this service stores data.
	BucketName = "team_membership"
)

Types

type Service

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

Service represents a service for managing environment(endpoint) data.

func NewService

func NewService(connection portainer.Connection) (*Service, error)

NewService creates a new instance of a service.

func (*Service) BucketName

func (service *Service) BucketName() string

func (*Service) Create

func (service *Service) Create(membership *portainer.TeamMembership) error

CreateTeamMembership creates a new TeamMembership object.

func (*Service) DeleteTeamMembership

func (service *Service) DeleteTeamMembership(ID portainer.TeamMembershipID) error

DeleteTeamMembership deletes a TeamMembership object.

func (*Service) DeleteTeamMembershipByTeamID

func (service *Service) DeleteTeamMembershipByTeamID(teamID portainer.TeamID) error

DeleteTeamMembershipByTeamID deletes all the TeamMembership object associated to a TeamID.

func (*Service) DeleteTeamMembershipByTeamIDAndUserID

func (service *Service) DeleteTeamMembershipByTeamIDAndUserID(teamID portainer.TeamID, userID portainer.UserID) error

func (*Service) DeleteTeamMembershipByUserID

func (service *Service) DeleteTeamMembershipByUserID(userID portainer.UserID) error

DeleteTeamMembershipByUserID deletes all the TeamMembership object associated to a UserID.

func (*Service) TeamMembership

func (service *Service) TeamMembership(ID portainer.TeamMembershipID) (*portainer.TeamMembership, error)

TeamMembership returns a TeamMembership object by ID

func (*Service) TeamMemberships

func (service *Service) TeamMemberships() ([]portainer.TeamMembership, error)

TeamMemberships return an array containing all the TeamMembership objects.

func (*Service) TeamMembershipsByTeamID

func (service *Service) TeamMembershipsByTeamID(teamID portainer.TeamID) ([]portainer.TeamMembership, error)

TeamMembershipsByTeamID return an array containing all the TeamMembership objects where the specified teamID is present.

func (*Service) TeamMembershipsByUserID

func (service *Service) TeamMembershipsByUserID(userID portainer.UserID) ([]portainer.TeamMembership, error)

TeamMembershipsByUserID return an array containing all the TeamMembership objects where the specified userID is present.

func (*Service) UpdateTeamMembership

func (service *Service) UpdateTeamMembership(ID portainer.TeamMembershipID, membership *portainer.TeamMembership) error

UpdateTeamMembership saves a TeamMembership object.