ExRets v0.1.1 ExRets.SessionInformation View Source

Number of days before the expiration date that the user should be warned of the upcoming password expiration. A value of "-1" indicates that the password expiration is disabled.

Functions

parse(key_value_body)

Parses session information returned as part of a login response.

Link to this section Types

agent_code()

(since 0.1.0)

agent_code() :: String.t()

Code that is stored in the property records for the listing agent, selling agent, etc.

balance()

(since 0.1.0)

balance() :: String.t() | nil

User-readable indication of the money balance in the account.

broker_branch()

(since 0.1.0)

broker_branch() :: String.t() | nil

Used in the validation routines of the Update transaction.

broker_code()

(since 0.1.0)

broker_code() :: String.t() | nil

Used in the validation routines of the Update transaction.

member_name()

(since 0.1.0)

member_name() :: String.t() | nil

Member's full name (display name) as it is to appear on any printed output; for example "Jane T. Row".

metadata_id()

(since 0.1.0)

metadata_id() :: String.t() | nil

Persistent ID associated with the metadata applied to the current user session.

metadata_timestamp()

(since 0.1.0)

metadata_timestamp() :: NaiveDateTime.t() | nil

Timestamp associated with the current version of metadata on the server.

metadata_version()

(since 0.1.0)

metadata_version() :: String.t() | nil

Most current version of the metadata that is available on the server.

min_metadata_timestamp()

(since 0.1.0)

min_metadata_timestamp() :: NaiveDateTime.t() | nil

Earliest version of the metadata that the server will support.

office_list()

(since 0.1.0)

office_list() :: [String.t()] | nil

Enumeration of the offices to which the server will permit login.

operator_name()

(since 0.1.0)

operator_name() :: String.t() | nil

Name of the MLS or Association operating the system.

password_expiration()

(since 0.1.0)

password_expiration() :: NaiveDateTime.t() | nil

Date that the current user password becomes invalid.

role_name()

(since 0.1.0)

role_name() :: String.t() | nil

Name of the role restriction where the metadata may be restricted.

server_product_name()

(since 0.1.0)

server_product_name() :: String.t() | nil

Name of the server product provided by the vendor.

server_product_version()

(since 0.1.0)

server_product_version() :: String.t() | nil

Version of the server product.

standard_names_version()

(since 0.1.0)

standard_names_version() :: String.t() | nil

Version of StandardNames that the server supports.

support_contact_information()

(since 0.1.0)

support_contact_information() :: String.t() | nil

Free text that provides a contact email, phone, or website for development support.

t()

(since 0.1.0)

t() :: %ExRets.SessionInformation{
  agent_code: agent_code(),
  balance: balance(),
  broker_branch: broker_branch(),
  broker_code: broker_code(),
  member_name: member_name(),
  metadata_id: metadata_id(),
  metadata_timestamp: metadata_timestamp(),
  metadata_version: metadata_version(),
  min_metadata_timestamp: min_metadata_timestamp(),
  office_list: office_list(),
  operator_name: operator_name(),
  password_expiration: password_expiration(),
  role_name: role_name(),
  server_product_name: server_product_name(),
  server_product_version: server_product_version(),
  standard_names_version: standard_names_version(),
  support_contact_information: support_contact_information(),
  timeout_seconds: timeout_seconds(),
  user_class: user_class(),
  user_id: user_id(),
  user_level: user_level(),
  vendor_name: vendor_name(),
  warn_password_expiration_days: warn_password_expiration_days()
}

Identity and parameter information.

timeout_seconds()

(since 0.1.0)

timeout_seconds() :: integer() | nil

Number of seconds after a transaction that a session will remain active.

user_class()

(since 0.1.0)

user_class() :: String.t()

Used in the validation routines of the Update transaction. Implementation dependent and may not exist on some systems.

user_id()

(since 0.1.0)

user_id() :: String.t()

ID of the signed in user.

user_level()

(since 0.1.0)

user_level() :: non_neg_integer()

Used in the validation routines of the Update transaction. Implementation dependent and may not exist on some systems.

vendor_name()

(since 0.1.0)

vendor_name() :: String.t() | nil

Name of the server product vendor.

warn_password_expiration_days()

(since 0.1.0)

warn_password_expiration_days() :: integer() | nil

Number of days before the expiration date that the user should be warned of the upcoming password expiration. A value of "-1" indicates that the password expiration is disabled.

Link to this section Functions

parse(key_value_body)

(since 0.1.0)

parse(ExRets.LoginResponse.key_value_body()) :: t()

Parses session information returned as part of a login response.

Attempts to parse data types into equivalent Elixir types, but will pass through invalid values as strings.

Examples

iex> ExRets.SessionInformation.parse("Info=USERID;Character;1")
%ExRets.SessionInformation{user_id: "1"}

iex> ExRets.SessionInformation.parse("Info=MetadataTimestamp;DateTime;2019-11-13T19:58:45Z")
%ExRets.SessionInformation{metadata_timestamp: ~N[2019-11-13T19:58:45Z]}

iex> ExRets.SessionInformation.parse("Info=MetadataTimestamp;DateTime;invalid")
%ExRets.SessionInformation{metadata_timestamp: "invalid"}