Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthenticatedAction

Hierarchy

  • CLSAction
    • AuthenticatedAction

Index

Constructors

constructor

Properties

Optional blockedConnectionTypes

blockedConnectionTypes?: string[]

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

description

description: string

The description of the Action (default this.name)

Optional inputs

inputs?: Inputs

The inputs of the Action (default: {})

Optional logLevel

logLevel?: ActionheroLogLevel

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

Optional matchExtensionMimeType

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)?

Optional middleware

middleware?: string[]

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

name

name: string

The name of the Action

Optional outputExample

outputExample?: object

permission

permission: { mode: ActionPermissionMode; topic: ActionPermissionTopic }

Type declaration

  • mode: ActionPermissionMode
  • topic: ActionPermissionTopic

Optional toDocument

toDocument?: boolean

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

Optional version

version?: string | number

The version of this Action (default: 1)

Methods

isWriteTransaction

  • isWriteTransaction(): boolean

run

  • run(params: ActionData): Promise<any>

Abstract runWithinTransaction

  • runWithinTransaction(params: ActionData): Promise<any>

validate

  • validate(): void
  • Returns void

Generated using TypeDoc