Class: E3DB::OutgoingSharingPolicy

Inherits:
Dry::Struct
  • Object
show all
Defined in:
lib/e3db/client.rb

Overview

Information about records shared with another client.

The Client#outgoing_sharing method returns a list of OutgoingSharingPolicy instances, each of which describes a rule allowing other E3DB clients to read records of a specific type.

Instance Attribute Summary collapse

Instance Attribute Details

#reader_id ⇒ String

Returns unique ID of the authorized reader.

Returns:

  • (String) —

    unique ID of the authorized reader



190
191
192
193
194
 
# File 'lib/e3db/client.rb', line 190

class OutgoingSharingPolicy < Dry::Struct
  attribute :reader_id, Types::Strict::String
  attribute :reader_name, Types::Strict::String.optional
  attribute :record_type, Types::Strict::String
end

#reader_name ⇒ String

Returns display name of reader, if available.

Returns:

  • (String) —

    display name of reader, if available



190
191
192
193
194
 
# File 'lib/e3db/client.rb', line 190

class OutgoingSharingPolicy < Dry::Struct
  attribute :reader_id, Types::Strict::String
  attribute :reader_name, Types::Strict::String.optional
  attribute :record_type, Types::Strict::String
end

#record_type ⇒ String

Returns type of record shared with reader.

Returns:

  • (String) —

    type of record shared with reader



190
191
192
193
194
 
# File 'lib/e3db/client.rb', line 190

class OutgoingSharingPolicy < Dry::Struct
  attribute :reader_id, Types::Strict::String
  attribute :reader_name, Types::Strict::String.optional
  attribute :record_type, Types::Strict::String
end