Skip to main content

Share

A Share existence allows public access to its associated publication. Typical use cases: free books, samples.

type Share {
  covert: Boolean!
  from: DateTime
  id: ID!
  newWebReaderUrl: URI!
  niceId: ID
  publication: Publication!
  to: DateTime
  webReaderUrl: URI!
}

Fields​

Share.covert ● Boolean! non-null scalar​

Whether the access to the publication is intended to be shared in a controlled way. If the share is covert, people should not be able to guess it. Therefore, only non 'covert' shares will have very concise niceId's.

Share.from ● DateTime scalar​

The moment after which the share grants public access to the publication.

Share.id ● ID! non-null scalar​

The canonical identifier of the share.

Share.newWebReaderUrl ● URI! non-null scalar​

A link pointing to a web page where the publication can be read with no authentication whatsoever required using the web reader.

Share.niceId ● ID scalar​

A global (to warehouse) unique identifier for the share, usable as part of an aesthetically pleasing URL. When the share is not 'covert' the niceId will be more marketing friendly: concise, easy to spell and 'printable'.

Share.publication ● Publication! non-null object​

The publication to which this share is attached.

Share.to ● DateTime scalar​

The moment until the share grants public access to the publication.

Share.webReaderUrl ● URI! non-null scalar​

A link pointing to a web page where the publication can be read with no authentication whatsoever required.

Returned by​

share query ● shareByNiceId query

Member of​

CreateSharePayload object ● ShareEdge object