Class: A2A::PushNotificationConfig

Inherits:

ProtocolStruct

• Object
• Dry::Struct
• ProtocolStruct
• A2A::PushNotificationConfig

Defined in:

lib/a2a/types/push_notification_config.rb

Overview

Defines the configuration for setting up push notifications for task updates.

Instance Method Summary

• #authentication ⇒ PushNotificationAuthenticationInfo^?

  Optional authentication details for the agent to use when calling the notification URL.

• #id ⇒ String^?

  A unique identifier (e.g. UUID) for the push notification configuration, set by the client to support multiple notification callbacks.

• #token ⇒ String^?

  A unique token for this task or session to validate incoming push notifications.

• #url ⇒ URI

  The callback URL where the agent should send push notifications.

Methods included from Extensions::CaseTransformation

#camelize, included, #to_json

Instance Method Details

#authentication ⇒ PushNotificationAuthenticationInfo^?

Returns Optional authentication details for the agent to use when calling the notification URL.

Returns:

• (PushNotificationAuthenticationInfo, nil) —

  Optional authentication details for the agent to use when calling the notification URL.

# File 'lib/a2a/types/push_notification_config.rb', line 18

attribute? :authentication, Types::Constructor(PushNotificationAuthenticationInfo).optional

#id ⇒ String^?

Returns A unique identifier (e.g. UUID) for the push notification configuration, set by the client to support multiple notification callbacks.

Returns:

• (String, nil) —

  A unique identifier (e.g. UUID) for the push notification configuration, set by the client to support multiple notification callbacks.

# File 'lib/a2a/types/push_notification_config.rb', line 8

attribute? :id, Types::String.optional

#token ⇒ String^?

Returns A unique token for this task or session to validate incoming push notifications.

Returns:

• (String, nil) —

  A unique token for this task or session to validate incoming push notifications.

# File 'lib/a2a/types/push_notification_config.rb', line 14

attribute? :token, Types::String.optional

#url ⇒ URI

Returns The callback URL where the agent should send push notifications.

Returns:

• (URI) —

  The callback URL where the agent should send push notifications.

# File 'lib/a2a/types/push_notification_config.rb', line 11

attribute :url, Types::URI