Class: Google::Apis::CloudsearchV1::ContextualAddOnMarkup

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

The markup for developers to specify the contents of a contextual AddOn. A contextual AddOn is triggered in context of an email. For that email, there can be N items that are associated with the email (e.g. contacts, sales lead, meeting information). Each item is represented as a "card". A card has two views, collapsed and detailed. If there are more than 1 card, the cards are show as a list of collapsed views. The end user can expand into the detailed view for each of those cards. In the detailed view, developers have the freedom to use a variety of "widgets" to construct it. The model here is to restrict (make consistent for end users) the navigation of the N cards but providing developers the freedom to build the detailed view that can best represent their use case/content. Go http://go/aoig-widgets1 to see the mocks. Post v1, we plan to support new AddOn use cases that will require different and separate 'templates'. For example, a compose triggered AddOn which will support a new set of use cases with different user interaction patterns. As a result, we will likely need a very different template than this one.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ContextualAddOnMarkup

Returns a new instance of ContextualAddOnMarkup.



6806
6807
6808
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6806

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cards ⇒ Array<Google::Apis::CloudsearchV1::Card>

A card must contain a header and at least 1 section. Corresponds to the JSON property cards

Returns:



6798
6799
6800
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6798

def cards
  @cards
end

#toolbar ⇒ Google::Apis::CloudsearchV1::Toolbar

The Toolbar markup has been deprecated. The information is now specified in the manifest. Corresponds to the JSON property toolbar

Returns:



6804
6805
6806
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6804

def toolbar
  @toolbar
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6811
6812
6813
6814
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6811

def update!(**args)
  @cards = args[:cards] if args.key?(:cards)
  @toolbar = args[:toolbar] if args.key?(:toolbar)
end