Used to build auth logout command definitions. Used automatically if you allow the "auth" command group to be generated

### Hierarchy

- AuthCommandBuilder
  - AuthLogoutCommandBuilder

### Implements

- AbstractCommandBuilder

## Index

### Constructors

- constructor

### Properties

- mAuthConfig
- mConfig
- mLogger
- mProfileType

### Methods

- build
- buildAuthSegmentFromConfig
- buildFull
- getAction

## Constructors

### constructor

- new AuthLogoutCommandBuilder(mProfileType: string, mLogger: Logger, mAuthConfig: ICommandProfileAuthConfig): AuthLogoutCommandBuilder

- Inherited from AuthCommandBuilder.constructor

  - Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthCommandBuilder.ts:26

  Construct the builder based on the auth config.

  #### Parameters

  - ##### mProfileType: string

    the profile name of the profile type e.g. banana

  - ##### mLogger: Logger

    logger instance to use for the builder class

  - ##### mAuthConfig: ICommandProfileAuthConfig

    the config for the auth type

  #### Returns AuthLogoutCommandBuilder

## Properties

### Protected mAuthConfig

mAuthConfig: ICommandProfileAuthConfig

Inherited from AuthCommandBuilder.mAuthConfig

- Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthCommandBuilder.ts:36

the config for the auth type

### Protected mConfig

mConfig: ICommandProfileAuthConfig

Inherited from AuthCommandBuilder.mConfig

- Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthCommandBuilder.ts:26

Auth config for the command.

### Protected mLogger

mLogger: Logger

Inherited from AuthCommandBuilder.mLogger

- Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthCommandBuilder.ts:35

logger instance to use for the builder class

### Protected mProfileType

mProfileType: string

Inherited from AuthCommandBuilder.mProfileType

- Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthCommandBuilder.ts:34

the profile name of the profile type e.g. banana

## Methods

### build

- build(): ICommandDefinition

- Inherited from AuthCommandBuilder.build

  - Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthCommandBuilder.ts:61

  Only constructs the "group" command segment for the document. Use this if the command definition document already includes an auth verb.

  #### Returns ICommandDefinition

### Protected buildAuthSegmentFromConfig

- buildAuthSegmentFromConfig(): ICommandDefinition

- Overrides AuthCommandBuilder.buildAuthSegmentFromConfig

  - Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthLogoutCommandBuilder.ts:43

  Builds only the "auth" segment from the auth config.

  #### Returns ICommandDefinition

### buildFull

- buildFull(): ICommandDefinition

- Overrides AuthCommandBuilder.buildFull

  - Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthLogoutCommandBuilder.ts:35

  Build the full command - includes action group and object command.

  #### Returns ICommandDefinition

  : The command definition.

### getAction

- getAction(): string

- Overrides AuthCommandBuilder.getAction

  - Defined in @zowe/imperative/src/imperative/src/auth/builders/AuthLogoutCommandBuilder.ts:27

  Gets the "action" that this command builder is building.

  #### Returns string

  : The "logout" action string

Generated using TypeDoc