Class ViewLocationAction

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>

    public final class ViewLocationAction
    extends com.google.api.client.json.GenericJson
    Opens the user's default map app and selects the agent-specified location or searches around the user's location given an agent-specified query.

    This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the RCS Business Messaging API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

    Author:
    Google, Inc.
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

        com.google.api.client.util.GenericData.Flags
      • Nested classes/interfaces inherited from class java.util.AbstractMap

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ViewLocationAction clone()  
      java.lang.String getLabel()
      (Optional) The label of the pin dropped at lat_long.
      LatLng getLatLong()
      (Optional) The latitude and longitude of the specified location.
      java.lang.String getQuery()
      (Optional, only supported on Android Messages clients) Rather than specify a lat_long (and optionally, a label), the agent can instead specify a query string.
      ViewLocationAction set​(java.lang.String fieldName, java.lang.Object value)  
      ViewLocationAction setLabel​(java.lang.String label)
      (Optional) The label of the pin dropped at lat_long.
      ViewLocationAction setLatLong​(LatLng latLong)
      (Optional) The latitude and longitude of the specified location.
      ViewLocationAction setQuery​(java.lang.String query)
      (Optional, only supported on Android Messages clients) Rather than specify a lat_long (and optionally, a label), the agent can instead specify a query string.
      • Methods inherited from class com.google.api.client.json.GenericJson

        getFactory, setFactory, toPrettyString, toString
      • Methods inherited from class com.google.api.client.util.GenericData

        entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
      • Methods inherited from class java.util.AbstractMap

        clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
    • Constructor Detail

      • ViewLocationAction

        public ViewLocationAction()
    • Method Detail

      • getLabel

        public java.lang.String getLabel()
        (Optional) The label of the pin dropped at lat_long.
        Returns:
        value or null for none
      • setLabel

        public ViewLocationAction setLabel​(java.lang.String label)
        (Optional) The label of the pin dropped at lat_long.
        Parameters:
        label - label or null for none
      • getLatLong

        public LatLng getLatLong()
        (Optional) The latitude and longitude of the specified location.
        Returns:
        value or null for none
      • setLatLong

        public ViewLocationAction setLatLong​(LatLng latLong)
        (Optional) The latitude and longitude of the specified location.
        Parameters:
        latLong - latLong or null for none
      • getQuery

        public java.lang.String getQuery()
        (Optional, only supported on Android Messages clients) Rather than specify a lat_long (and optionally, a label), the agent can instead specify a query string. For default map apps that support search functionality (including Google Maps), tapping this suggested action results in a location search centered around the user's current location. If the query is sufficiently specific, then agents can use it to select any location in the world. For instance, setting the query string to "Growing Tree Bank" will show all Growing Tree Bank locations in the user's vicinity. Setting the query string to "1600 Amphitheater Parkway, Mountain View, CA 94043" will select that specific address, regardless of the user's location.
        Returns:
        value or null for none
      • setQuery

        public ViewLocationAction setQuery​(java.lang.String query)
        (Optional, only supported on Android Messages clients) Rather than specify a lat_long (and optionally, a label), the agent can instead specify a query string. For default map apps that support search functionality (including Google Maps), tapping this suggested action results in a location search centered around the user's current location. If the query is sufficiently specific, then agents can use it to select any location in the world. For instance, setting the query string to "Growing Tree Bank" will show all Growing Tree Bank locations in the user's vicinity. Setting the query string to "1600 Amphitheater Parkway, Mountain View, CA 94043" will select that specific address, regardless of the user's location.
        Parameters:
        query - query or null for none
      • set

        public ViewLocationAction set​(java.lang.String fieldName,
                                      java.lang.Object value)
        Overrides:
        set in class com.google.api.client.json.GenericJson
      • clone

        public ViewLocationAction clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson