push

Documentation

Index

• func Send(context *common.Context)
• func Short(context *common.Context)
• func WebPush(ctx *common.Context)

Functions

func Send

func Send(context *common.Context)

Send godoc

@Summary      Send notification
@Id           sendMessage
@Tags         Message
@Description  Send notification to user_id
@Param        user_secret  path      string         true   "Secret of user"
@Param        title        formData  string         false  "Message Title"  default(Notification)
@Param        content      formData  string         true   "Message Content"
@Param        long         formData  string         false  "Long Message Content (optional)"
@Param        priority     formData  enum.Priority  false  "The priority of message"  default(normal)
@Produce      json
@Success      200  {object}  common.Response[models.Message]
@Failure      400  {object}  common.BadRequestResponse
@Failure      401  {object}  common.UnauthorizedResponse
@Router       /{user_secret}/send  [post]

func Short

func Short(context *common.Context)

Short godoc

@Summary      Send notification
@Id           sendMessageLite
@Tags         Message
@Description  Send notification to user_id
@Param        user_secret  path  string  true  "Secret of user"
@Param        string       body  string  true  "Message Content"
@Accept       plain
@Produce      json
@Success      200  {object}  common.Response[models.Message]
@Failure      400  {object}  common.BadRequestResponse
@Failure      401  {object}  common.UnauthorizedResponse
@Router       /{user_secret} [post]

func WebPush

func WebPush(ctx *common.Context)

WebPush

@Summary      Endpoint for webpush info check
@Id           webpush
@Tags         Push
@Description  Check if this znotify instance support webpush and get public key
@Produce      json
@Success      200  {object}  common.Response[info]
@Router       /webpush [get]