Package org.botblock.javabotblockapi.requests

## Enum GetListAction.ApiField

- java.lang.Object
- - java.lang.Enum<GetListAction.ApiField>
  - - org.botblock.javabotblockapi.requests.GetListAction.ApiField

- All Implemented Interfaces:
    `Serializable`, `Comparable<GetListAction.ApiField>`
  Enclosing class:
    GetListAction

      public static enum GetListAction.ApiField
      extends Enum<GetListAction.ApiField>

  Enum containing the different API fields a bot list may have.
  This is used for `GetListAction#getApiField(String, Site|String, ApiField)`
  Since:
    5.0.0

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant | Description
    --- | ---
    `API_ALL` | Deprecated. Since: 5.2.0 Replacement: `URL_ALL`
    `API_DOCS` | Deprecated. Since: 5.2.0 Replacement: `URL_DOCS`
    `API_FIELD` | Deprecated. Since: 5.2.0 Replacement: `STRING_SERVER_COUNT`
    `API_GET` | Deprecated. Since: 5.2.0 Replacement: `URL_GET`
    `API_POST` | Deprecated. Since: 5.2.0 Replacement: `URL_POST`
    `API_SHARD_COUNT` | Deprecated. Since: 5.2.0 Replacement: `STRING_SHARD_COUNT`
    `API_SHARD_ID` | Deprecated. Since: 5.2.0 Replacement: `STRING_SHARD_ID`
    `API_SHARDS` | Deprecated. Since: 5.2.0 Replacement: `STRING_SHARDS`
    `STRING_SERVER_COUNT` | Name of the field for the server count.
    `STRING_SHARD_COUNT` | Name of the field for the shard count.
    `STRING_SHARD_ID` | Name of the field for the shard id.
    `STRING_SHARDS` | Name of the field for the shards.
    `URL_ALL` | URL to GET all listed bots on a bot list.
    `URL_DOCS` | URL to view the API documentation of the bot list
    `URL_GET` | URL to GET information about a single bot listed on the bot list.
    `URL_POST` | URL to POST the server count to a bot list.

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `static GetListAction.ApiField` | `valueOf​(String name)` | Returns the enum constant of this type with the specified name.
    `static GetListAction.ApiField[]` | `values()` | Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### API_ALL

          @Deprecated
          @DeprecatedSince(version="5.2.0",
                           replacements="#URL_ALL")
          @PlannedRemoval(version="5.2.3")
          public static final GetListAction.ApiField API_ALL

      Deprecated.
      Since: 5.2.0
      Replacement: `URL_ALL`
      API field to return the URL to list all bots of a bot list.

    - #### API_DOCS

          @Deprecated
          @DeprecatedSince(version="5.2.0",
                           replacements="#URL_DOCS")
          @PlannedRemoval(version="5.2.3")
          public static final GetListAction.ApiField API_DOCS

      Deprecated.
      Since: 5.2.0
      Replacement: `URL_DOCS`
      API field to return the URL to the API documentation of the bot list.

    - #### API_GET

          @Deprecated
          @DeprecatedSince(version="5.2.0",
                           replacements="#URL_GET")
          @PlannedRemoval(version="5.2.3")
          public static final GetListAction.ApiField API_GET

      Deprecated.
      Since: 5.2.0
      Replacement: `URL_GET`
      API field to return the URL used to GET information about a bot.

    - #### API_POST

          @Deprecated
          @DeprecatedSince(version="5.2.0",
                           replacements="#URL_POST")
          @PlannedRemoval(version="5.2.3")
          public static final GetListAction.ApiField API_POST

      Deprecated.
      Since: 5.2.0
      Replacement: `URL_POST`
      API field to return the URL used to POST information from a bot.

    - #### API_FIELD

          @Deprecated
          @DeprecatedSince(version="5.2.0",
                           replacements="#STRING_SERVER_COUNT")
          @PlannedRemoval(version="5.2.3")
          public static final GetListAction.ApiField API_FIELD

      Deprecated.
      Since: 5.2.0
      Replacement: `STRING_SERVER_COUNT`
      Name of the field for posting the server count (i.e. `server_count`)

    - #### API_SHARD_ID

          @Deprecated
          @DeprecatedSince(version="5.2.0",
                           replacements="#STRING_SHARD_ID")
          @PlannedRemoval(version="5.2.3")
          public static final GetListAction.ApiField API_SHARD_ID

      Deprecated.
      Since: 5.2.0
      Replacement: `STRING_SHARD_ID`
      Name of the field for posting the shard id (i.e. `shard_id`)

    - #### API_SHARD_COUNT

          @Deprecated
          @DeprecatedSince(version="5.2.0",
                           replacements="#STRING_SHARD_COUNT")
          @PlannedRemoval(version="5.2.3")
          public static final GetListAction.ApiField API_SHARD_COUNT

      Deprecated.
      Since: 5.2.0
      Replacement: `STRING_SHARD_COUNT`
      Name of the field for posting the shard count (i.e. `shard_count`)

    - #### API_SHARDS

          @Deprecated
          @DeprecatedSince(version="5.2.0",
                           replacements="#STRING_SHARDS")
          @PlannedRemoval(version="5.2.3")
          public static final GetListAction.ApiField API_SHARDS

      Deprecated.
      Since: 5.2.0
      Replacement: `STRING_SHARDS`
      Name of the field for posting the different shard info (i.e. `shards`)

    - #### STRING_SERVER_COUNT

          public static final GetListAction.ApiField STRING_SERVER_COUNT

      Name of the field for the server count. Example: `server_count`
      Since:
        5.2.0

    - #### STRING_SHARD_ID

          public static final GetListAction.ApiField STRING_SHARD_ID

      Name of the field for the shard id. Example: `shard_id`
      Since:
        5.2.0

    - #### STRING_SHARD_COUNT

          public static final GetListAction.ApiField STRING_SHARD_COUNT

      Name of the field for the shard count. Example: `shard_count`
      Since:
        5.2.0

    - #### STRING_SHARDS

          public static final GetListAction.ApiField STRING_SHARDS

      Name of the field for the shards. Example: `shards`
      Since:
        5.2.0

    - #### URL_ALL

          public static final GetListAction.ApiField URL_ALL

      URL to GET all listed bots on a bot list.
      Since:
        5.2.0

    - #### URL_DOCS

          public static final GetListAction.ApiField URL_DOCS

      URL to view the API documentation of the bot list
      Since:
        5.2.0

    - #### URL_GET

          public static final GetListAction.ApiField URL_GET

      URL to GET information about a single bot listed on the bot list.
      Since:
        5.2.0

    - #### URL_POST

          public static final GetListAction.ApiField URL_POST

      URL to POST the server count to a bot list.
      Since:
        5.2.0

  - ### Method Detail

    - #### values

          public static GetListAction.ApiField[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (GetListAction.ApiField c : GetListAction.ApiField.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static GetListAction.ApiField valueOf​(String name)

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
        `name` - the name of the enum constant to be returned.
      Returns:
        the enum constant with the specified name
      Throws:
        `IllegalArgumentException` - if this enum type has no constant with the specified name
        `NullPointerException` - if the argument is null