InvitesResource

Creates and accepts invites.

  • Stable unknown
  • Release candidate since 0.1.0-rc.4
  • Development since 0.1.0-dev.24+fa54770
public final class InvitesResource

Creates and accepts invites. Get it from Ovok.invites().

Methods

recordShares

public InvitesResource.Flow recordShares()

Returns the record-share invite routes (/v1/invites/record-share).

Returns: the record-share invite routes

care

public InvitesResource.Flow care()

Returns the care invite routes (/v1/invites/care).

Returns: the care invite routes

practitioners

public InvitesResource.Flow practitioners()

Returns the practitioner-invite routes (/v1/invites/practitioner).

Deprecated: Deprecated route; use recordShares() for practitioner shares.

Returns: the practitioner-invite routes

patients

public InvitesResource.Flow patients()

Returns the patient-invite routes (/v1/invites/patient).

Deprecated: Deprecated route; use care().

Returns: the patient-invite routes

InvitesResource.Flow

public static final class Flow

Creates and accepts invites of one kind.

Flow.create

public JsonNode create(Object body, RequestOptions options) throws IOException, InterruptedException

Creates an invite (POST /v1/invites/{kind}).

Parameters:

  • body: the invite request
  • options: per-request options, such as the timeout

Returns: the response body

Throws:

  • IOException: if the request cannot be sent or the response cannot be read
  • InterruptedException: if the thread is interrupted while waiting for the response

Flow.accept

public JsonNode accept(Object body, RequestOptions options) throws IOException, InterruptedException

Accepts an invite (POST /v1/invites/{kind}/accept).

Parameters:

  • body: the accept request
  • options: per-request options, such as the timeout

Returns: the response body

Throws:

  • IOException: if the request cannot be sent or the response cannot be read
  • InterruptedException: if the thread is interrupted while waiting for the response

Last updated on

On this page