Documentation
¶
Index ¶
- Variables
- func GetKeyHash(key string) string
- func GetOAuthKey(mattermostUserID string) string
- func GetProjectKey(projectID, mattermostUserID string) string
- func GetProjectListMapKey() string
- type ProjectList
- type ProjectListMap
- type Store
- func (s *Store) AtomicModify(key string, modify func(initialValue []byte) ([]byte, error)) error
- func (s *Store) AtomicModifyWithOptions(key string, ...) error
- func (s *Store) Delete(key string) error
- func (s *Store) DeleteProject(project *serializers.ProjectDetails) error
- func (s *Store) DeleteUser(mattermostUserID string) (bool, error)
- func (s *Store) Ensure(key string, newValue []byte) ([]byte, error)
- func (s *Store) GetAllProjects(userID string) ([]serializers.ProjectDetails, error)
- func (s *Store) GetProject() (*ProjectList, error)
- func (s *Store) Load(key string) ([]byte, error)
- func (s *Store) LoadJSON(key string, v interface{}) (returnErr error)
- func (s *Store) LoadUser(mattermostUserID string) (*User, error)
- func (s *Store) Store(key string, data []byte) error
- func (s *Store) StoreJSON(key string, v interface{}) (returnErr error)
- func (s *Store) StoreOAuthState(mattermostUserID, state string) error
- func (s *Store) StoreProject(project *serializers.ProjectDetails) error
- func (s *Store) StoreTTL(key string, data []byte, ttlSeconds int64) error
- func (s *Store) StoreUser(user *User) error
- func (s *Store) StoreWithOptions(key string, value []byte, opts model.PluginKVSetOptions) (bool, error)
- func (s *Store) VerifyOAuthState(mattermostUserID, state string) error
- type User
Constants ¶
This section is empty.
Variables ¶
var ErrNotFound = errors.New("not found")
Functions ¶
func GetKeyHash ¶
GetKeyHash can be used to create a hash from a string
func GetOAuthKey ¶
func GetProjectKey ¶
func GetProjectListMapKey ¶
func GetProjectListMapKey() string
Types ¶
type ProjectList ¶
type ProjectList struct {
ByMattermostUserID map[string]ProjectListMap
}
func NewProjectList ¶
func NewProjectList() *ProjectList
func ProjectListFromJSON ¶
func ProjectListFromJSON(bytes []byte) (*ProjectList, error)
func (*ProjectList) AddProject ¶
func (projectList *ProjectList) AddProject(userID string, project *serializers.ProjectDetails)
func (*ProjectList) DeleteProjectByKey ¶
func (projectList *ProjectList) DeleteProjectByKey(userID, projectKey string)
type ProjectListMap ¶
type ProjectListMap map[string]serializers.ProjectDetails
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
func (*Store) AtomicModify ¶
AtomicModify calls AtomicModifyWithOptions with nil PluginKVSetOptions to atomically modify a value in KVStore and set it for an indefinite time See AtomicModifyWithOptions for more info
func (*Store) AtomicModifyWithOptions ¶
func (s *Store) AtomicModifyWithOptions(key string, modify func(initialValue []byte) ([]byte, *model.PluginKVSetOptions, error)) error
AtomicModifyWithOptions modifies the value for a key in KVStore, only if the initial value is not changed while attempting to modify it. To avoid race conditions, we retry the modification multiple times after waiting for a fixed wait interval. input: kv store key and a modify function which takes initial value and returns final value with PluginKVSetOptions and error. returns: nil for a successful update and error if the update is unsuccessful or the retry limit reached.
func (*Store) DeleteProject ¶
func (s *Store) DeleteProject(project *serializers.ProjectDetails) error
func (*Store) Ensure ¶
Ensure makes sure the initial value for a key is set to the value provided, if it does not already exist Returns the value set for the key in kv-store and error
func (*Store) GetAllProjects ¶
func (s *Store) GetAllProjects(userID string) ([]serializers.ProjectDetails, error)
func (*Store) GetProject ¶
func (s *Store) GetProject() (*ProjectList, error)
func (*Store) LoadJSON ¶
LoadJSON loads a json value stored in the KVStore using StoreJSON unmarshalling it to an interface using json.Unmarshal
func (*Store) StoreJSON ¶
StoreJSON stores a json value from an interface to KVStore after marshaling it using json.Marshal
func (*Store) StoreOAuthState ¶
func (*Store) StoreProject ¶
func (s *Store) StoreProject(project *serializers.ProjectDetails) error
Source Files