Package com.symphony.bdk.core.activity.parsing

Class Arguments

java.lang.Object
com.symphony.bdk.core.activity.parsing.Arguments
@API(status=STABLE) public class Arguments extends Object
Class storing arguments matching a SlashCommandPattern

  • Constructor Details

    • Arguments

      public Arguments()

    • Arguments

      public Arguments(Map<String,Object> arguments)

  • Method Details

    • getArgumentNames

      public Set<String> getArgumentNames()
      Returns:
      the set of argument names

    • get

      public Object get(String argumentName)
      Parameters:
      argumentName - the name of the argument to be retrieved
      Returns:
      the argument value if present, null otherwise. Actual type of value can be String, Mention, Cashtag, Hashtag depending on the corresponding SlashCommandPattern.

    • getAsString

      public String getAsString(String argumentName)
      Parameters:
      argumentName - the name of the argument to be retrieved
      Returns:
      the string representation of the argument if present, null otherwise

    • getString

      public String getString(String argumentName)
      Parameters:
      argumentName - the name of the argument to be retrieved
      Returns:
      the argument value if present and if is of type String, null otherwise

    • getHashtag

      public Hashtag getHashtag(String argumentName)
      Parameters:
      argumentName - the name of the argument to be retrieved
      Returns:
      the argument value if present and if is of type Hashtag, null otherwise

    • getCashtag

      public Cashtag getCashtag(String argumentName)
      Parameters:
      argumentName - the name of the argument to be retrieved
      Returns:
      the argument value if present and if is of type Cashtag, null otherwise

    • getMention

      public Mention getMention(String argumentName)
      Parameters:
      argumentName - the name of the argument to be retrieved
      Returns:
      the argument value if present and if is of type Mention, null otherwise