elixir_google_spreadsheets v0.1.16 GSS.Registry
Google spreadsheets core authorization. Automatically updates access token after expiration.
Link to this section Summary
Types
State of Google Cloud API :
%{
auth: %Goth.Token{
expires: 1453356568,
token: "ya29.cALlJ4HHWRvMkYB-WsAR-CZnexE459yA7QPqKg3nei1y2T7-iqmbcgxb8XrTATNn_Blim",
type: "Bearer"
}
}
Functions
Returns a specification to start this module under a supervisor
Get pid of sheet in :active_sheets registry
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Add or replace Google Spreadsheet in a registry
Fetch Google Spreadsheet proccess by it's id in the registry
Get account authorization token
Link to this section Types
state()
state() :: map()
state() :: map()
State of Google Cloud API :
%{
auth: %Goth.Token{
expires: 1453356568,
token: "ya29.cALlJ4HHWRvMkYB-WsAR-CZnexE459yA7QPqKg3nei1y2T7-iqmbcgxb8XrTATNn_Blim",
type: "Bearer"
}
}
Link to this section Functions
child_spec(init_arg)
Returns a specification to start this module under a supervisor.
See Supervisor
.
handle_call(msg, from, state)
Get pid of sheet in :active_sheets registry.
init(state)
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
,
except that it also sets a timeout. See the "Timeouts" section
in the module documentation for more information.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
new_spreadsheet(spreadsheet_id, pid, opts \\ [])
Add or replace Google Spreadsheet in a registry.
spreadsheet_pid(spreadsheet_id, opts \\ [])
Fetch Google Spreadsheet proccess by it's id in the registry.
start_link()
start_link() :: {:ok, pid()}
start_link() :: {:ok, pid()}
token()
token() :: String.t()
token() :: String.t()
Get account authorization token.