dashboardmodels

Documentation

Index

• type APIInterface
• type APIOptions
• type OverrideStruct
• type RecipeInterface
• type ThirdParty
• type TypeAuthMode
• type TypeInput
• type TypeNormalisedInput
• type UserType

Types

type APIInterface

type APIInterface struct {
	DashboardGET *func(options APIOptions, userContext supertokens.UserContext) (string, error)
}

type APIOptions

type APIOptions struct {
	RecipeImplementation RecipeInterface
	AppInfo              supertokens.NormalisedAppinfo
	Config               TypeNormalisedInput
	RecipeID             string
	Req                  *http.Request
	Res                  http.ResponseWriter
	OtherHandler         http.HandlerFunc
}

type OverrideStruct

type OverrideStruct struct {
	Functions func(originalImplementation RecipeInterface) RecipeInterface
	APIs      func(originalImplementation APIInterface) APIInterface
}

type RecipeInterface

type RecipeInterface struct {
	GetDashboardBundleLocation *func(userContext supertokens.UserContext) (string, error)
	ShouldAllowAccess          *func(req *http.Request, config TypeNormalisedInput, userContext supertokens.UserContext) (bool, error)
}

type ThirdParty

type ThirdParty struct {
	Id     string `json:"id"`
	UserId string `json:"userId"`
}

type TypeAuthMode

type TypeAuthMode string

const (
	AuthModeEmailPassword TypeAuthMode = "email-password"
	AuthModeAPIKey        TypeAuthMode = "api-key"
)

type TypeInput

type TypeInput struct {
	ApiKey   string
	Admins   *[]string
	Override *OverrideStruct
}

type TypeNormalisedInput

type TypeNormalisedInput struct {
	ApiKey   string
	Admins   *[]string
	AuthMode TypeAuthMode
	Override OverrideStruct
}

type UserType

type UserType struct {
	Id         string      `json:"id,omitempty"`
	TimeJoined uint64      `json:"timeJoined,omitempty"`
	FirstName  string      `json:"firstName,omitempty"`
	LastName   string      `json:"lastName,omitempty"`
	Email      string      `json:"email,omitempty"`
	ThirdParty *ThirdParty `json:"thirdParty,omitempty"`
	Phone      string      `json:"phoneNumber,omitempty"`
	TenantIds  []string    `json:"tenantIds,omitempty"`
}