Documentation
¶
Index ¶
- Constants
- func ApiHandler(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler
- func ApiHandlerTrustRequester(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler
- func ApiSessionRequired(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler
- func ApiSessionRequiredMfa(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler
- func ApiSessionRequiredTrustRequester(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler
- func CheckBadRequestStatus(t *testing.T, resp *model.Response)
- func CheckErrorMessage(t *testing.T, resp *model.Response, errorId string)
- func CheckEtag(t *testing.T, data interface{}, resp *model.Response)
- func CheckForbiddenStatus(t *testing.T, resp *model.Response)
- func CheckNoError(t *testing.T, resp *model.Response)
- func CheckNotFoundStatus(t *testing.T, resp *model.Response)
- func CheckNotImplementedStatus(t *testing.T, resp *model.Response)
- func CheckUnauthorizedStatus(t *testing.T, resp *model.Response)
- func CheckUserSanitization(t *testing.T, user *model.User)
- func GenerateTestChannelName() string
- func GenerateTestEmail() string
- func GenerateTestId() string
- func GenerateTestTeamName() string
- func GenerateTestUsername() string
- func Handle404(w http.ResponseWriter, r *http.Request)
- func HandleEtag(etag string, routeName string, w http.ResponseWriter, r *http.Request) bool
- func InitApi(full bool)
- func InitChannel()
- func InitFile()
- func InitPost()
- func InitPreference()
- func InitRouter()
- func InitSystem()
- func InitTeam()
- func InitUser()
- func InitWebhook()
- func LinkUserToTeam(user *model.User, team *model.Team)
- func Logout(c *Context, w http.ResponseWriter, r *http.Request)
- func NewInvalidParamError(parameter string) *model.AppError
- func NewInvalidUrlParamError(parameter string) *model.AppError
- func ReturnStatusOK(w http.ResponseWriter)
- func TearDown()
- func VerifyUserEmail(userId string)
- type ApiParams
- type Context
- func (c *Context) GetSiteURL() string
- func (c *Context) IsSystemAdmin() bool
- func (c *Context) LogAudit(extraInfo string)
- func (c *Context) LogAuditWithUserId(userId, extraInfo string)
- func (c *Context) LogDebug(err *model.AppError)
- func (c *Context) LogError(err *model.AppError)
- func (c *Context) MfaRequired()
- func (c *Context) RemoveSessionCookie(w http.ResponseWriter, r *http.Request)
- func (c *Context) RequireCategory() *Context
- func (c *Context) RequireChannelId() *Context
- func (c *Context) RequireChannelName() *Context
- func (c *Context) RequireEmail() *Context
- func (c *Context) RequireFileId() *Context
- func (c *Context) RequirePostId() *Context
- func (c *Context) RequirePreferenceName() *Context
- func (c *Context) RequireTeamId() *Context
- func (c *Context) RequireTeamName() *Context
- func (c *Context) RequireUserId() *Context
- func (c *Context) RequireUsername() *Context
- func (c *Context) SessionRequired()
- func (c *Context) SetInvalidParam(parameter string)
- func (c *Context) SetInvalidUrlParam(parameter string)
- func (c *Context) SetPermissionError(permission *model.Permission)
- func (c *Context) SetSiteURL(url string)
- type Routes
- type TestHelper
- func (me *TestHelper) CreateChannelWithClient(client *model.Client4, channelType string) *model.Channel
- func (me *TestHelper) CreateClient() *model.Client4
- func (me *TestHelper) CreateMessagePost(message string) *model.Post
- func (me *TestHelper) CreateMessagePostWithClient(client *model.Client4, channel *model.Channel, message string) *model.Post
- func (me *TestHelper) CreatePost() *model.Post
- func (me *TestHelper) CreatePostWithClient(client *model.Client4, channel *model.Channel) *model.Post
- func (me *TestHelper) CreatePrivateChannel() *model.Channel
- func (me *TestHelper) CreatePublicChannel() *model.Channel
- func (me *TestHelper) CreateTeam() *model.Team
- func (me *TestHelper) CreateTeamWithClient(client *model.Client4) *model.Team
- func (me *TestHelper) CreateUser() *model.User
- func (me *TestHelper) CreateUserWithClient(client *model.Client4) *model.User
- func (me *TestHelper) InitBasic() *TestHelper
- func (me *TestHelper) InitSystemAdmin() *TestHelper
- func (me *TestHelper) LoginBasic()
- func (me *TestHelper) LoginBasic2()
- func (me *TestHelper) LoginBasic2WithClient(client *model.Client4)
- func (me *TestHelper) LoginBasicWithClient(client *model.Client4)
- func (me *TestHelper) LoginSystemAdmin()
- func (me *TestHelper) LoginSystemAdminWithClient(client *model.Client4)
- func (me *TestHelper) LoginTeamAdmin()
- func (me *TestHelper) LoginTeamAdminWithClient(client *model.Client4)
- func (me *TestHelper) UpdateActiveUser(user *model.User, active bool)
Constants ¶
View Source
const ( PAGE_DEFAULT = 0 PER_PAGE_DEFAULT = 60 PER_PAGE_MAXIMUM = 200 )
View Source
const (
FILE_TEAM_ID = "noteam"
)
Variables ¶
This section is empty.
Functions ¶
func ApiHandler ¶
func ApiSessionRequired ¶
func ApiSessionRequiredMfa ¶
func GenerateTestChannelName ¶
func GenerateTestChannelName() string
func GenerateTestEmail ¶
func GenerateTestEmail() string
func GenerateTestId ¶
func GenerateTestId() string
func GenerateTestTeamName ¶
func GenerateTestTeamName() string
func GenerateTestUsername ¶
func GenerateTestUsername() string
func HandleEtag ¶
func InitChannel ¶
func InitChannel()
func InitPreference ¶
func InitPreference()
func InitRouter ¶
func InitRouter()
func InitSystem ¶
func InitSystem()
func InitWebhook ¶
func InitWebhook()
func NewInvalidParamError ¶
func NewInvalidUrlParamError ¶
func ReturnStatusOK ¶
func ReturnStatusOK(w http.ResponseWriter)
func VerifyUserEmail ¶
func VerifyUserEmail(userId string)
Types ¶
type ApiParams ¶
type ApiParams struct {
UserId string
TeamId string
ChannelId string
PostId string
FileId string
CommandId string
HookId string
EmojiId string
Email string
Username string
TeamName string
ChannelName string
PreferenceName string
Category string
Page int
PerPage int
}
func ApiParamsFromRequest ¶
type Context ¶
type Context struct {
Session model.Session
Params *ApiParams
Err *model.AppError
T goi18n.TranslateFunc
RequestId string
IpAddress string
Path string
// contains filtered or unexported fields
}
func (*Context) GetSiteURL ¶
func (*Context) IsSystemAdmin ¶
func (*Context) LogAuditWithUserId ¶
func (*Context) MfaRequired ¶
func (c *Context) MfaRequired()
func (*Context) RemoveSessionCookie ¶
func (c *Context) RemoveSessionCookie(w http.ResponseWriter, r *http.Request)
func (*Context) RequireCategory ¶
func (*Context) RequireChannelId ¶
func (*Context) RequireChannelName ¶
func (*Context) RequireEmail ¶
func (*Context) RequireFileId ¶
func (*Context) RequirePostId ¶
func (*Context) RequirePreferenceName ¶
func (*Context) RequireTeamId ¶
func (*Context) RequireTeamName ¶
func (*Context) RequireUserId ¶
func (*Context) RequireUsername ¶
func (*Context) SessionRequired ¶
func (c *Context) SessionRequired()
func (*Context) SetInvalidParam ¶
func (*Context) SetInvalidUrlParam ¶
func (*Context) SetPermissionError ¶
func (c *Context) SetPermissionError(permission *model.Permission)
func (*Context) SetSiteURL ¶
type Routes ¶
type Routes struct {
Root *mux.Router // ”
ApiRoot *mux.Router // 'api/v4'
Users *mux.Router // 'api/v4/users'
User *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}'
UserByUsername *mux.Router // 'api/v4/users/username/{username:[A-Za-z0-9_-\.]+}'
UserByEmail *mux.Router // 'api/v4/users/email/{email}'
Teams *mux.Router // 'api/v4/teams'
TeamsForUser *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams'
Team *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}'
TeamByName *mux.Router // 'api/v4/teams/name/{team_name:[A-Za-z0-9_-]+}'
TeamMembers *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9_-]+}/members'
TeamMember *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9_-]+}/members/{user_id:[A-Za-z0-9_-]+}'
Channels *mux.Router // 'api/v4/channels'
Channel *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}'
ChannelByName *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}/channels/name/{channel_name:[A-Za-z0-9_-]+}'
ChannelByNameForTeamName *mux.Router // 'api/v4/teams/name/{team_name:[A-Za-z0-9_-]+}/channels/name/{channel_name:[A-Za-z0-9_-]+}'
ChannelsForTeam *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}/channels'
ChannelMembers *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}/members'
ChannelMember *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}/members/{user_id:[A-Za-z0-9]+}'
ChannelMembersForUser *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams/{team_id:[A-Za-z0-9]+}/channels/members'
Posts *mux.Router // 'api/v4/posts'
Post *mux.Router // 'api/v4/posts/{post_id:[A-Za-z0-9]+}'
PostsForChannel *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}/posts'
Files *mux.Router // 'api/v4/files'
File *mux.Router // 'api/v4/files/{file_id:[A-Za-z0-9]+}'
Commands *mux.Router // 'api/v4/commands'
Command *mux.Router // 'api/v4/commands/{command_id:[A-Za-z0-9]+}'
CommandsForTeam *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}/commands'
Hooks *mux.Router // 'api/v4/hooks'
IncomingHooks *mux.Router // 'api/v4/hooks/incoming'
IncomingHook *mux.Router // 'api/v4/hooks/incoming/{hook_id:[A-Za-z0-9]+}'
OutgoingHooks *mux.Router // 'api/v4/hooks/outgoing'
OutgoingHook *mux.Router // 'api/v4/hooks/outgoing/{hook_id:[A-Za-z0-9]+}'
OAuth *mux.Router // 'api/v4/oauth'
Admin *mux.Router // 'api/v4/admin'
System *mux.Router // 'api/v4/system'
Preferences *mux.Router // 'api/v4/preferences'
License *mux.Router // 'api/v4/license'
Public *mux.Router // 'api/v4/public'
Emojis *mux.Router // 'api/v4/emoji'
Emoji *mux.Router // 'api/v4/emoji/{emoji_id:[A-Za-z0-9]+}'
Webrtc *mux.Router // 'api/v4/webrtc'
}
var BaseRoutes *Routes
type TestHelper ¶
type TestHelper struct {
Client *model.Client4
BasicUser *model.User
BasicUser2 *model.User
TeamAdminUser *model.User
BasicTeam *model.Team
BasicChannel *model.Channel
BasicChannel2 *model.Channel
BasicPost *model.Post
SystemAdminClient *model.Client4
SystemAdminUser *model.User
}
func Setup ¶
func Setup() *TestHelper
func (*TestHelper) CreateChannelWithClient ¶
func (*TestHelper) CreateClient ¶
func (me *TestHelper) CreateClient() *model.Client4
func (*TestHelper) CreateMessagePost ¶
func (me *TestHelper) CreateMessagePost(message string) *model.Post
func (*TestHelper) CreateMessagePostWithClient ¶
func (*TestHelper) CreatePost ¶
func (me *TestHelper) CreatePost() *model.Post
func (*TestHelper) CreatePostWithClient ¶
func (*TestHelper) CreatePrivateChannel ¶
func (me *TestHelper) CreatePrivateChannel() *model.Channel
func (*TestHelper) CreatePublicChannel ¶
func (me *TestHelper) CreatePublicChannel() *model.Channel
func (*TestHelper) CreateTeam ¶
func (me *TestHelper) CreateTeam() *model.Team
func (*TestHelper) CreateTeamWithClient ¶
func (me *TestHelper) CreateTeamWithClient(client *model.Client4) *model.Team
func (*TestHelper) CreateUser ¶
func (me *TestHelper) CreateUser() *model.User
func (*TestHelper) CreateUserWithClient ¶
func (me *TestHelper) CreateUserWithClient(client *model.Client4) *model.User
func (*TestHelper) InitBasic ¶
func (me *TestHelper) InitBasic() *TestHelper
func (*TestHelper) InitSystemAdmin ¶
func (me *TestHelper) InitSystemAdmin() *TestHelper
func (*TestHelper) LoginBasic ¶
func (me *TestHelper) LoginBasic()
func (*TestHelper) LoginBasic2 ¶
func (me *TestHelper) LoginBasic2()
func (*TestHelper) LoginBasic2WithClient ¶
func (me *TestHelper) LoginBasic2WithClient(client *model.Client4)
func (*TestHelper) LoginBasicWithClient ¶
func (me *TestHelper) LoginBasicWithClient(client *model.Client4)
func (*TestHelper) LoginSystemAdmin ¶
func (me *TestHelper) LoginSystemAdmin()
func (*TestHelper) LoginSystemAdminWithClient ¶
func (me *TestHelper) LoginSystemAdminWithClient(client *model.Client4)
func (*TestHelper) LoginTeamAdmin ¶
func (me *TestHelper) LoginTeamAdmin()
func (*TestHelper) LoginTeamAdminWithClient ¶
func (me *TestHelper) LoginTeamAdminWithClient(client *model.Client4)
func (*TestHelper) UpdateActiveUser ¶
func (me *TestHelper) UpdateActiveUser(user *model.User, active bool)
Click to show internal directories.
Click to hide internal directories.