Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CheckNameAvailabilityResult

Package version

interface

An interface representing CheckNameAvailabilityResult. The CheckNameAvailability operation response.

Hierarchy

  • CheckNameAvailabilityResult

Index

Properties

Properties

Optional message

message: undefined | string
member

{string} [message] Gets an error message explaining the Reason value in more detail. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nameAvailable

nameAvailable: undefined | false | true
member

{boolean} [nameAvailable] Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reason

reason: NameAvailabilityReason
member

{NameAvailabilityReason} [reason] Gets the reason that a project name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: 'Available', 'Invalid', 'AlreadyExists' NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc