Module: Slack::Web::Api::Endpoints::Entity

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/entity.rb

Instance Method Summary collapse

Instance Method Details

#entity_presentDetails(options = {}) ⇒ Object

Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :metadata (object) —

    URL-encoded JSON object containing flexpane metadata from the app that will be conformed to a Work Object metadata schema, keyed by entity ID.

  • :trigger_id (string) —

    A reference to the original user action that initiated the request.

  • :user_auth_required (boolean) —

    Set to true (or 1) to indicate that the user must authenticate to view full flexpane data.

  • :user_auth_url (string) —

    A custom URL to which users are directed for authentication if required.

  • :error (Object)

Raises:

  • (ArgumentError)

See Also:



23
24
25
26
27
 
# File 'lib/slack/web/api/endpoints/entity.rb', line 23

def entity_presentDetails(options = {})
  raise ArgumentError, 'Required arguments :trigger_id missing' if options[:trigger_id].nil?
  options = encode_options_as_json(options, %i[metadata])
  post('entity.presentDetails', options)
end