client

package module

Go to main page

Versions in this module

v0

v0.7.0

Jan 6, 2022

Changes in this version

type Playbook

+ Members []PlaybookMember

+ Public bool

type PlaybookCreateOptions

+ Members []PlaybookMember

+ Public bool

type PlaybookListOptions

+ SearchTeam string

+ type PlaybookMember struct

+ Roles []string

+ SchemeRoles []string

+ UserID string

type PlaybookRun

+ CategorizeChannelEnabled bool

type PlaybookRunListOptions

+ ParticipantOrFollowerID string

type PlaybookRunMetadata

+ Followers []string

type PlaybookRunService

+ func (s *PlaybookRunService) AddChecklistItem(ctx context.Context, playbookRunID string, checklistNumber int, ...) error

+ func (s *PlaybookRunService) CreateChecklist(ctx context.Context, playbookRunID string, checklist Checklist) error

+ func (s *PlaybookRunService) MoveChecklist(ctx context.Context, playbookRunID string, ...) error

+ func (s *PlaybookRunService) MoveChecklistItem(ctx context.Context, playbookRunID string, ...) error

+ func (s *PlaybookRunService) RemoveChecklist(ctx context.Context, playbookRunID string, checklistNumber int) error

+ func (s *PlaybookRunService) RenameChecklist(ctx context.Context, playbookRunID string, checklistNumber int, ...) error

type PlaybooksService

+ func (s *PlaybooksService) Archive(ctx context.Context, playbookID string) error

v0.6.0

Sep 15, 2021

Changes in this version

+ const Me

type Playbook

+ BroadcastChannelIDs []string

+ BroadcastEnabled bool

+ ExportChannelOnFinishedEnabled bool

type PlaybookCreateOptions

+ BroadcastChannelIDs []string

+ BroadcastEnabled bool

type PlaybookRun

+ ExportChannelOnFinishedEnabled bool

type PlaybookRunListOptions

+ ParticipantID string

+ Statuses []Status

type PlaybookRunMetadata

+ NumParticipants int64

type PlaybookRunService

+ func (s *PlaybookRunService) Finish(ctx context.Context, playbookRunID string) error

type Status

+ const StatusFinished

+ const StatusInProgress

v0.5.0

Aug 18, 2021

Changes in this version

+ type Checklist struct

+ ID string

+ Items []ChecklistItem

+ Title string

+ type ChecklistItem struct

+ AssigneeID string

+ AssigneeModified int64

+ AssigneeModifiedPostID string

+ Command string

+ CommandLastRun int64

+ Description string

+ ID string

+ State string

+ StateModified int64

+ StateModifiedPostID string

+ Title string

+ type Client struct

+ BaseURL *url.URL

+ PlaybookRuns *PlaybookRunService

+ Playbooks *PlaybooksService

+ Settings *SettingsService

+ UserAgent string

+ func New(client4 *model.Client4) (*Client, error)

+ type ErrorResponse struct

+ Err error

+ Method string

+ StatusCode int

+ URL string

+ func (e *ErrorResponse) UnmarshalJSON(data []byte) error

+ func (r *ErrorResponse) Error() string

+ func (r *ErrorResponse) Unwrap() error

+ type GetPlaybookRunsResults struct

+ Disabled bool

+ HasMore bool

+ Items []PlaybookRun

+ PageCount int

+ TotalCount int

+ type GetPlaybooksResults struct

+ HasMore bool

+ Items []Playbook

+ PageCount int

+ TotalCount int

+ type GlobalSettings struct

+ EnableExperimentalFeatures bool

+ PlaybookCreatorsUserIds []string

+ type Playbook struct

+ AnnouncementChannelEnabled bool

+ AnnouncementChannelID string

+ BroadcastChannelID string

+ Checklists []Checklist

+ CreateAt int64

+ CreatePublicPlaybookRun bool

+ DefaultOwnerEnabled bool

+ DefaultOwnerID string

+ DeleteAt int64

+ Description string

+ ExportChannelOnArchiveEnabled bool

+ ID string

+ InvitedGroupIDs []string

+ InvitedUserIDs []string

+ InvitedUsersEnabled bool

+ MemberIDs []string

+ NumStages int64

+ NumSteps int64

+ ReminderMessageTemplate string

+ ReminderTimerDefaultSeconds int64

+ TeamID string

+ Title string

+ type PlaybookCreateOptions struct

+ AnnouncementChannelEnabled bool

+ AnnouncementChannelID string

+ BroadcastChannelID string

+ Checklists []Checklist

+ CreatePublicPlaybookRun bool

+ DefaultOwnerEnabled bool

+ DefaultOwnerID string

+ Description string

+ InviteUsersEnabled bool

+ InvitedGroupIDs []string

+ InvitedUserIDs []string

+ MemberIDs []string

+ ReminderMessageTemplate string

+ ReminderTimerDefaultSeconds int64

+ TeamID string

+ Title string

+ type PlaybookListOptions struct

+ Direction SortDirection

+ Sort Sort

+ type PlaybookRun struct

+ ActiveStage int

+ ActiveStageTitle string

+ BroadcastChannelID string

+ ChannelID string

+ Checklists []Checklist

+ CreateAt int64

+ DeleteAt int64

+ Description string

+ EndAt int64

+ ExportChannelOnArchiveEnabled bool

+ ID string

+ InvitedGroupIDs []string

+ InvitedUserIDs []string

+ Name string

+ OwnerUserID string

+ PlaybookID string

+ PostID string

+ PreviousReminder time.Duration

+ ReminderMessageTemplate string

+ ReminderPostID string

+ ReporterUserID string

+ StatusPosts []StatusPost

+ TeamID string

+ TimelineEvents []TimelineEvent

+ type PlaybookRunCreateOptions struct

+ Description string

+ Name string

+ OwnerUserID string

+ PlaybookID string

+ PostID string

+ TeamID string

+ type PlaybookRunList struct

+ HasMore bool

+ Items []*PlaybookRun

+ PageCount int

+ TotalCount int

+ type PlaybookRunListOptions struct

+ ActiveGTE int64

+ ActiveLT int64

+ Direction SortDirection

+ MemberID string

+ OwnerID string

+ PlaybookID string

+ SearchTerm string

+ Sort Sort

+ StartedGTE int64

+ StartedLT int64

+ Status Status

+ TeamID string

+ type PlaybookRunMetadata struct

+ ChannelDisplayName string

+ ChannelName string

+ NumMembers int64

+ TeamName string

+ TotalPosts int64

+ type PlaybookRunService struct

+ func (s *PlaybookRunService) Create(ctx context.Context, opts PlaybookRunCreateOptions) (*PlaybookRun, error)

+ func (s *PlaybookRunService) Get(ctx context.Context, playbookRunID string) (*PlaybookRun, error)

+ func (s *PlaybookRunService) GetByChannelID(ctx context.Context, channelID string) (*PlaybookRun, error)

+ func (s *PlaybookRunService) GetMetadata(ctx context.Context, playbookRunID string) (*PlaybookRunMetadata, error)

+ func (s *PlaybookRunService) List(ctx context.Context, page, perPage int, opts PlaybookRunListOptions) (*GetPlaybookRunsResults, error)

+ func (s *PlaybookRunService) UpdateStatus(ctx context.Context, playbookRunID string, status Status, message string, ...) error

+ type PlaybooksService struct

+ func (s *PlaybooksService) Create(ctx context.Context, opts PlaybookCreateOptions) (*Playbook, error)

+ func (s *PlaybooksService) Delete(ctx context.Context, playbookID string) error

+ func (s *PlaybooksService) Get(ctx context.Context, playbookID string) (*Playbook, error)

+ func (s *PlaybooksService) List(ctx context.Context, teamId string, page, perPage int, ...) (*GetPlaybooksResults, error)

+ func (s *PlaybooksService) Update(ctx context.Context, playbook Playbook) error

+ type SettingsService struct

+ func (s *SettingsService) Get(ctx context.Context) (*GlobalSettings, error)

+ func (s *SettingsService) Update(ctx context.Context, settings GlobalSettings) error

+ type Sort string

+ const SortByCreateAt

+ const SortByEndAt

+ const SortByID

+ const SortByName

+ const SortByOwnerUserID

+ const SortByRuns

+ const SortByStages

+ const SortBySteps

+ const SortByTeamID

+ const SortByTitle

+ type SortDirection string

+ const SortAsc

+ const SortDesc

+ type Status string

+ const StatusActive

+ const StatusArchived

+ const StatusReported

+ const StatusResolved

+ type StatusPost struct

+ CreateAt int64

+ DeleteAt int64

+ ID string

+ type StatusUpdateOptions struct

+ Message string

+ ReminderInSeconds int64

+ Status Status

+ type TimelineEvent struct

+ CreateAt int64

+ CreatorUserID string

+ DeleteAt int64

+ Details string

+ EventAt int64

+ EventType TimelineEventType

+ ID string

+ PlaybookRunID string

+ PostID string

+ SubjectUserID string

+ Summary string

+ type TimelineEventType string

+ const AssigneeChanged

+ const OwnerChanged

+ const PlaybookRunCreated

+ const RanSlashCommand

+ const StatusUpdated

+ const TaskStateModified

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL