Class: E3DB::IncomingSharingPolicy

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

Overview

Information about records shared with this client.

The Client#incoming_sharing method returns a list of IncomingSharingPolicy instances, each of which describes a rule allowing this client to read records of a specific type, written by another client.

Instance Attribute Summary collapse

Instance Attribute Details

#record_typeString

Returns type of record shared with this client.

Returns:

  • (String)

    type of record shared with this client



171
172
173
174
175
# File 'lib/e3db/client.rb', line 171

class IncomingSharingPolicy < Dry::Struct
  attribute :writer_id, Types::Strict::String
  attribute :writer_name, Types::Strict::String.optional
  attribute :record_type, Types::Strict::String
end

#writer_idString

Returns unique ID of the writer that shared with this client.

Returns:

  • (String)

    unique ID of the writer that shared with this client



171
172
173
174
175
# File 'lib/e3db/client.rb', line 171

class IncomingSharingPolicy < Dry::Struct
  attribute :writer_id, Types::Strict::String
  attribute :writer_name, Types::Strict::String.optional
  attribute :record_type, Types::Strict::String
end

#writer_nameString

Returns display name of the writer, if available.

Returns:

  • (String)

    display name of the writer, if available



171
172
173
174
175
# File 'lib/e3db/client.rb', line 171

class IncomingSharingPolicy < Dry::Struct
  attribute :writer_id, Types::Strict::String
  attribute :writer_name, Types::Strict::String.optional
  attribute :record_type, Types::Strict::String
end