Documentation
¶
Index ¶
- Constants
- type IndexNotifications
- type IndexNotificationsBadRequest
- type IndexNotificationsHandler
- type IndexNotificationsHandlerFunc
- type IndexNotificationsInternalServerError
- type IndexNotificationsNotFound
- type IndexNotificationsOK
- func (o *IndexNotificationsOK) SetContentRange(contentRange string)
- func (o *IndexNotificationsOK) SetPayload(payload adminmessages.Notifications)
- func (o *IndexNotificationsOK) WithContentRange(contentRange string) *IndexNotificationsOK
- func (o *IndexNotificationsOK) WithPayload(payload adminmessages.Notifications) *IndexNotificationsOK
- func (o *IndexNotificationsOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type IndexNotificationsParams
- type IndexNotificationsURL
- func (o *IndexNotificationsURL) Build() (*url.URL, error)
- func (o *IndexNotificationsURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *IndexNotificationsURL) Must(u *url.URL, err error) *url.URL
- func (o *IndexNotificationsURL) SetBasePath(bp string)
- func (o *IndexNotificationsURL) String() string
- func (o *IndexNotificationsURL) StringFull(scheme, host string) string
- func (o *IndexNotificationsURL) WithBasePath(bp string) *IndexNotificationsURL
- type IndexNotificationsUnauthorized
Constants ¶
const IndexNotificationsBadRequestCode int = 400
IndexNotificationsBadRequestCode is the HTTP code returned for type IndexNotificationsBadRequest
const IndexNotificationsInternalServerErrorCode int = 500
IndexNotificationsInternalServerErrorCode is the HTTP code returned for type IndexNotificationsInternalServerError
const IndexNotificationsNotFoundCode int = 404
IndexNotificationsNotFoundCode is the HTTP code returned for type IndexNotificationsNotFound
const IndexNotificationsOKCode int = 200
IndexNotificationsOKCode is the HTTP code returned for type IndexNotificationsOK
IndexNotificationsUnauthorizedCode is the HTTP code returned for type IndexNotificationsUnauthorized
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IndexNotifications ¶
type IndexNotifications struct {
Context *middleware.Context
Handler IndexNotificationsHandler
}
IndexNotifications swagger:route GET /notifications Notifications indexNotifications
List Notifications ¶
This endpoint returns a list of Notifications that have been sent to Service Members. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.
func NewIndexNotifications ¶
func NewIndexNotifications(ctx *middleware.Context, handler IndexNotificationsHandler) *IndexNotifications
NewIndexNotifications creates a new http.Handler for the index notifications operation
func (*IndexNotifications) ServeHTTP ¶
func (o *IndexNotifications) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type IndexNotificationsBadRequest ¶
type IndexNotificationsBadRequest struct {
}
IndexNotificationsBadRequest invalid request
swagger:response indexNotificationsBadRequest
func NewIndexNotificationsBadRequest ¶
func NewIndexNotificationsBadRequest() *IndexNotificationsBadRequest
NewIndexNotificationsBadRequest creates IndexNotificationsBadRequest with default headers values
func (*IndexNotificationsBadRequest) WriteResponse ¶
func (o *IndexNotificationsBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexNotificationsHandler ¶
type IndexNotificationsHandler interface {
Handle(IndexNotificationsParams) middleware.Responder
}
IndexNotificationsHandler interface for that can handle valid index notifications params
type IndexNotificationsHandlerFunc ¶
type IndexNotificationsHandlerFunc func(IndexNotificationsParams) middleware.Responder
IndexNotificationsHandlerFunc turns a function with the right signature into a index notifications handler
func (IndexNotificationsHandlerFunc) Handle ¶
func (fn IndexNotificationsHandlerFunc) Handle(params IndexNotificationsParams) middleware.Responder
Handle executing the request and returning a response
type IndexNotificationsInternalServerError ¶
type IndexNotificationsInternalServerError struct {
}
IndexNotificationsInternalServerError server error
swagger:response indexNotificationsInternalServerError
func NewIndexNotificationsInternalServerError ¶
func NewIndexNotificationsInternalServerError() *IndexNotificationsInternalServerError
NewIndexNotificationsInternalServerError creates IndexNotificationsInternalServerError with default headers values
func (*IndexNotificationsInternalServerError) WriteResponse ¶
func (o *IndexNotificationsInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexNotificationsNotFound ¶
type IndexNotificationsNotFound struct {
}
IndexNotificationsNotFound Notifications not found
swagger:response indexNotificationsNotFound
func NewIndexNotificationsNotFound ¶
func NewIndexNotificationsNotFound() *IndexNotificationsNotFound
NewIndexNotificationsNotFound creates IndexNotificationsNotFound with default headers values
func (*IndexNotificationsNotFound) WriteResponse ¶
func (o *IndexNotificationsNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexNotificationsOK ¶
type IndexNotificationsOK struct {
/*Used for pagination
*/
ContentRange string `json:"Content-Range"`
/*
In: Body
*/
Payload adminmessages.Notifications `json:"body,omitempty"`
}
IndexNotificationsOK success
swagger:response indexNotificationsOK
func NewIndexNotificationsOK ¶
func NewIndexNotificationsOK() *IndexNotificationsOK
NewIndexNotificationsOK creates IndexNotificationsOK with default headers values
func (*IndexNotificationsOK) SetContentRange ¶
func (o *IndexNotificationsOK) SetContentRange(contentRange string)
SetContentRange sets the contentRange to the index notifications o k response
func (*IndexNotificationsOK) SetPayload ¶
func (o *IndexNotificationsOK) SetPayload(payload adminmessages.Notifications)
SetPayload sets the payload to the index notifications o k response
func (*IndexNotificationsOK) WithContentRange ¶
func (o *IndexNotificationsOK) WithContentRange(contentRange string) *IndexNotificationsOK
WithContentRange adds the contentRange to the index notifications o k response
func (*IndexNotificationsOK) WithPayload ¶
func (o *IndexNotificationsOK) WithPayload(payload adminmessages.Notifications) *IndexNotificationsOK
WithPayload adds the payload to the index notifications o k response
func (*IndexNotificationsOK) WriteResponse ¶
func (o *IndexNotificationsOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexNotificationsParams ¶
type IndexNotificationsParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*
In: query
*/
Filter *string
/*
In: query
*/
Order *bool
/*
In: query
*/
Page *int64
/*
In: query
*/
PerPage *int64
/*
In: query
*/
Sort *string
}
IndexNotificationsParams contains all the bound params for the index notifications operation typically these are obtained from a http.Request
swagger:parameters indexNotifications
func NewIndexNotificationsParams ¶
func NewIndexNotificationsParams() IndexNotificationsParams
NewIndexNotificationsParams creates a new IndexNotificationsParams object
There are no default values defined in the spec.
func (*IndexNotificationsParams) BindRequest ¶
func (o *IndexNotificationsParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewIndexNotificationsParams() beforehand.
type IndexNotificationsURL ¶
type IndexNotificationsURL struct {
Filter *string
Order *bool
Page *int64
PerPage *int64
Sort *string
// contains filtered or unexported fields
}
IndexNotificationsURL generates an URL for the index notifications operation
func (*IndexNotificationsURL) Build ¶
func (o *IndexNotificationsURL) Build() (*url.URL, error)
Build a url path and query string
func (*IndexNotificationsURL) BuildFull ¶
func (o *IndexNotificationsURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*IndexNotificationsURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*IndexNotificationsURL) SetBasePath ¶
func (o *IndexNotificationsURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*IndexNotificationsURL) String ¶
func (o *IndexNotificationsURL) String() string
String returns the string representation of the path with query string
func (*IndexNotificationsURL) StringFull ¶
func (o *IndexNotificationsURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*IndexNotificationsURL) WithBasePath ¶
func (o *IndexNotificationsURL) WithBasePath(bp string) *IndexNotificationsURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type IndexNotificationsUnauthorized ¶
type IndexNotificationsUnauthorized struct {
}
IndexNotificationsUnauthorized request requires user authentication
swagger:response indexNotificationsUnauthorized
func NewIndexNotificationsUnauthorized ¶
func NewIndexNotificationsUnauthorized() *IndexNotificationsUnauthorized
NewIndexNotificationsUnauthorized creates IndexNotificationsUnauthorized with default headers values
func (*IndexNotificationsUnauthorized) WriteResponse ¶
func (o *IndexNotificationsUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
Source Files