Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthenticatedAction

Hierarchy

  • CLSAction
    • AuthenticatedAction

Index

Constructors

Properties

blockedConnectionTypes?: string[]

Are there connections from any servers which cannot use this Action (default: [])?

description: string

The description of the Action (default this.name)

inputs?: Inputs

The inputs of the Action (default: {})

logLevel?: ActionheroLogLevel

Under what level should connections to this Action be logged (default 'info')?

matchExtensionMimeType?: boolean

If this Action is responding to a web request, and that request has a file extension like *.jpg, should Actionhero set the response headers to match that extension (default: true)?

middleware?: string[]

The Middleware specific to this Action (default: []). Middleware is described by the string names of the middleware.

name: string

The name of the Action

outputExample?: object
permission: ActionPermission
toDocument?: boolean

Should this Action appear in api.documentation.documentation? (default: true)?

version?: string | number

The version of this Action (default: 1)

Methods

  • isWriteTransaction(): boolean
  • run(params: ActionData): Promise<any>
  • runWithinTransaction(params: ActionData): Promise<any>
  • validate(): void
  • Returns void

Generated using TypeDoc