Skip to content

Commit

Permalink
docs: Remove hoodie.account.ready from the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@michsch @gr2m
michsch authored and gr2m committed May 10, 2017
1 parent aaa1331 commit cabc849
Showing 1 changed file with 17 additions and 27 deletions.
44 changes: 17 additions & 27 deletions docs/api/client/hoodie.account.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ user </camp/hoodieverse/glossary.html#private-user-store>`__, it makes
sense to familiarise yourself with **account** before you move on to
`store </camp/techdocs/api/client/hoodie.store.html>`__.

``hoodie-account-client`` is a JavaScript client for the
`Account JSON API <http://docs.accountjsonapi.apiary.io/>`_.
It persists session information in localStorage (or your own store API) and
provides front-end friendly APIs for the authentication-related operations as
``hoodie-account-client`` is a JavaScript client for the
`Account JSON API <http://docs.accountjsonapi.apiary.io/>`_.
It persists session information in localStorage (or your own store API) and
provides front-end friendly APIs for the authentication-related operations as
mentioned above.

Example
Expand All @@ -26,23 +26,15 @@ Example
hoodie.account.on('signout', redirectToHome)
.. _label-hoodie-account-ready:

hoodie.account.ready
--------------------

`Read-only`. Promise that resolves once the account instance loaded its current state from the store.

hoodie.account.id
-----------------

`Read-only`. Returns the account id. Cannot be accessed until the :ref:`label-hoodie-account-ready` promise resolved.
`Read-only`. Returns the account id.

hoodie.account.username
-----------------------

`Read-only`. Returns the username if signed in, otherwise ``undefined``. Cannot be accessed until the :ref:`label-hoodie-account-ready` promise resolved.
`Read-only`. Returns the username if signed in, otherwise ``undefined``.

hoodie.account.validate
-----------------------
Expand Down Expand Up @@ -87,8 +79,7 @@ Example
hoodie.account.isSignedIn
-------------------------

Returns ``true`` if user is currently signed in, otherwise ``false``.
Cannot be accessed until the :ref:`label-hoodie-account-ready` promise resolved.
Returns ``true`` if user is currently signed in, otherwise ``false``.

.. code:: js
Expand All @@ -97,9 +88,8 @@ Cannot be accessed until the :ref:`label-hoodie-account-ready` promise resolved.
hoodie.account.hasInvalidSession
--------------------------------

Checks ``hoodie.account.session.invalid property``. Returns ``true``
if user has invalid session, otherwise ``undefined``.
Cannot be accessed until the :ref:`label-hoodie-account-ready` promise resolved.
Checks ``hoodie.account.session.invalid property``. Returns ``true``
if user has invalid session, otherwise ``undefined``.

.. code:: js
Expand All @@ -108,7 +98,7 @@ Cannot be accessed until the :ref:`label-hoodie-account-ready` promise resolved.
hoodie.account.signUp
---------------------

Creates a new user account on the Hoodie server.
Creates a new user account on the Hoodie server.
Does `not` sign in the user automatically, :ref:`label-hoodie-account-signIn` must be called separately.

.. code:: js
Expand Down Expand Up @@ -305,7 +295,7 @@ Example
hoodie.account.get
------------------

Returns account properties from local cache. Cannot be accessed until the :ref:`label-hoodie-account-ready` promise resolved.
Returns account properties from local cache.

.. code:: js
Expand Down Expand Up @@ -411,7 +401,7 @@ Rejects with:
+--------------------------+----------------------------------------+
| ``InvalidError`` | Custom validation error |
+--------------------------+----------------------------------------+
| ``ConflictError`` | Username **<username>** already exists |
| ``ConflictError`` | Username **<username>** already exists |
+--------------------------+----------------------------------------+
| ``ConnectionError`` | Could not connect to server |
+--------------------------+----------------------------------------+
Expand All @@ -427,15 +417,15 @@ Example
account.profile.get
-------------------

Returns profile properties from local cache. Cannot be accessed until the :ref:`label-hoodie-account-ready` promise resolved.
Returns profile properties from local cache.

.. code:: js
account.profile.get(properties)
+----------------+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+
| Argument | Type | Description | Required |
+================+=============================+===============================================================================================================================================================================+============+
+================+=============================+===============================================================================================================================================================================+============+
| ``properties`` | String or Array of strings | When String, only this property gets returned. If array of strings, only passed properties get returned. Property names can have `.` separators to return nested properties. | No |
+----------------+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+

Expand Down Expand Up @@ -485,7 +475,7 @@ Rejects with:
+--------------------------+--------------------------------+
| ``UnauthenticatedError`` | Session is invalid |
+--------------------------+--------------------------------+
| ``ConnectionError`` | Could not connect to server |
| ``ConnectionError`` | Could not connect to server |
+--------------------------+--------------------------------+

Examples
Expand Down Expand Up @@ -654,9 +644,9 @@ Events
+--------------------+---------------------------------------------------------------------------------+--------------------------------------------------+
| ``signout`` | Successfully signed out | ``accountProperties`` with ``.session property`` |
+--------------------+---------------------------------------------------------------------------------+--------------------------------------------------+
| ``passwordreset`` | Email with password reset token sent | |
| ``passwordreset`` | Email with password reset token sent | |
+--------------------+---------------------------------------------------------------------------------+--------------------------------------------------+
| ``unauthenticate`` | Server responded with "unauthenticated" when checking session | |
| ``unauthenticate`` | Server responded with "unauthenticated" when checking session | |
+--------------------+---------------------------------------------------------------------------------+--------------------------------------------------+
| ``reauthenticate`` | Successfully signed in with the same username (useful when session has expired) | ``accountProperties`` with ``.session property`` |
+--------------------+---------------------------------------------------------------------------------+--------------------------------------------------+
Expand Down

0 comments on commit cabc849

Please sign in to comment.