Class: Google::Apps::Card::V1::OpenLink

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/apps/card/v1/card.rb

Overview

Represents an onClick event that opens a hyperlink.

Google Workspace Add-ons and Chat apps:

Defined Under Namespace

Modules: OnClose, OpenAs

Instance Attribute Summary collapse

Instance Attribute Details

#on_close ⇒ ::Google::Apps::Card::V1::OpenLink::OnClose

Returns Whether the client forgets about a link after opening it, or observes it until the window closes.

Google Workspace Add-ons:.

Returns:



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1898

class OpenLink
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # When an `OnClick` action opens a link, then the client can either open it
  # as a full-size window (if that's the frame used by the client), or an
  # overlay (such as a pop-up). The implementation depends on the client
  # platform capabilities, and the value selected might be ignored if the
  # client doesn't support it. `FULL_SIZE` is supported by all clients.
  #
  # [Google Workspace
  # Add-ons](https://developers.google.com/workspace/add-ons):
  module OpenAs
    # The link opens as a full-size window (if that's the frame used by the
    # client).
    FULL_SIZE = 0

    # The link opens as an overlay, such as a pop-up.
    OVERLAY = 1
  end

  # What the client does when a link opened by an `OnClick` action is closed.
  #
  # Implementation depends on client platform capabilities. For example, a web
  # browser might open a link in a pop-up window with an `OnClose` handler.
  #
  # If both `OnOpen` and `OnClose` handlers are set, and the client platform
  # can't support both values, `OnClose` takes precedence.
  #
  # [Google Workspace
  # Add-ons](https://developers.google.com/workspace/add-ons):
  module OnClose
    # Default value. The card doesn't reload; nothing happens.
    NOTHING = 0

    # Reloads the card after the child window closes.
    #
    # If used in conjunction with
    # [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#openas),
    # the child window acts as a modal dialog and the parent card is blocked
    # until the child window closes.
    RELOAD = 1
  end
end

#open_as ⇒ ::Google::Apps::Card::V1::OpenLink::OpenAs

Returns How to open a link.

Google Workspace Add-ons:.

Returns:



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1898

class OpenLink
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # When an `OnClick` action opens a link, then the client can either open it
  # as a full-size window (if that's the frame used by the client), or an
  # overlay (such as a pop-up). The implementation depends on the client
  # platform capabilities, and the value selected might be ignored if the
  # client doesn't support it. `FULL_SIZE` is supported by all clients.
  #
  # [Google Workspace
  # Add-ons](https://developers.google.com/workspace/add-ons):
  module OpenAs
    # The link opens as a full-size window (if that's the frame used by the
    # client).
    FULL_SIZE = 0

    # The link opens as an overlay, such as a pop-up.
    OVERLAY = 1
  end

  # What the client does when a link opened by an `OnClick` action is closed.
  #
  # Implementation depends on client platform capabilities. For example, a web
  # browser might open a link in a pop-up window with an `OnClose` handler.
  #
  # If both `OnOpen` and `OnClose` handlers are set, and the client platform
  # can't support both values, `OnClose` takes precedence.
  #
  # [Google Workspace
  # Add-ons](https://developers.google.com/workspace/add-ons):
  module OnClose
    # Default value. The card doesn't reload; nothing happens.
    NOTHING = 0

    # Reloads the card after the child window closes.
    #
    # If used in conjunction with
    # [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#openas),
    # the child window acts as a modal dialog and the parent card is blocked
    # until the child window closes.
    RELOAD = 1
  end
end

#url ⇒ ::String

Returns The URL to open.

Returns:

  • (::String) —

    The URL to open.



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1898

class OpenLink
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # When an `OnClick` action opens a link, then the client can either open it
  # as a full-size window (if that's the frame used by the client), or an
  # overlay (such as a pop-up). The implementation depends on the client
  # platform capabilities, and the value selected might be ignored if the
  # client doesn't support it. `FULL_SIZE` is supported by all clients.
  #
  # [Google Workspace
  # Add-ons](https://developers.google.com/workspace/add-ons):
  module OpenAs
    # The link opens as a full-size window (if that's the frame used by the
    # client).
    FULL_SIZE = 0

    # The link opens as an overlay, such as a pop-up.
    OVERLAY = 1
  end

  # What the client does when a link opened by an `OnClick` action is closed.
  #
  # Implementation depends on client platform capabilities. For example, a web
  # browser might open a link in a pop-up window with an `OnClose` handler.
  #
  # If both `OnOpen` and `OnClose` handlers are set, and the client platform
  # can't support both values, `OnClose` takes precedence.
  #
  # [Google Workspace
  # Add-ons](https://developers.google.com/workspace/add-ons):
  module OnClose
    # Default value. The card doesn't reload; nothing happens.
    NOTHING = 0

    # Reloads the card after the child window closes.
    #
    # If used in conjunction with
    # [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#openas),
    # the child window acts as a modal dialog and the parent card is blocked
    # until the child window closes.
    RELOAD = 1
  end
end