Description

This service allows you to enable application-wide features of the library.

At the moment the only feature is the UI Router integration, which is documented below.

Methods

ngRouter(config)

Call this method to enable the integration with the ngRoute module.

When enabled, you can define Stormpath Route Configurations on your routes. This object allows you to define access control for the route.

You can pass config options to this integration, the options control the default behavior around "need to login" and "forbidden" situations. If you wish to implement your own logic for these situations, simply omit the options and use the events (documented below) to know what is happening in the application.

Parameters

Param	Type	Details
config	object	`autoRedirect` - Defaults to true. After the user logs in at the route defined by `loginRoute`, they will be redirected back to the route that was originally requested. `defaultPostLoginRoute` - Where the user should be sent, after login, if they have visited the login page directly. If you do not define a value, nothing will happen at the login route. You can alternatively use the $authenticated event to know that login is successful. `forbiddenRoute` - The route that we should send the user to if they try to an access a view that they are not authorized to view. This happens in response to an `authorize` rule in one of your Stormpath Route Configurations `loginRoute` - The route name that we should send the user to if they need to login. You'll probably use `login` for this value.

Example

angular.module('myApp')
  .run(function($stormpath){
    $stormpath.ngRouter({
      forbiddenRoute: '/forbidden',
      defaultPostLoginRoute: '/home',
      loginRoute: '/login'
    });
  });

uiRouter(config)

Call this method to enable the integration with the UI Router module.

When enabled, you can define Stormpath State Configurations on your UI states. This object allows you to define access control for the state.

Parameters

Param	Type	Details
config	object	`autoRedirect` - Defaults to true. After the user logs in at the state defined by `loginState`, they will be redirected back to the state that was originally requested. `defaultPostLoginState` - Where the user should be sent, after login, if they have visited the login page directly. If you do not define a value, nothing will happen at the login state. You can alternatively use the $authenticated event to know that login is successful. `forbiddenState` - The UI state name that we should send the user to if they try to an access a view that they are not authorized to view. This happens in response to an `authorize` rule in one of your Stormpath State Configurations `loginState` - The UI state name that we should send the user to if they need to login. You'll probably use `login` for this value.

Example

angular.module('myApp')
  .run(function($stormpath){
    $stormpath.uiRouter({
      forbiddenState: 'forbidden',
      defaultPostLoginState: 'main',
      loginState: 'login'
    });
  });

Events

$routeChangeUnauthenticated
This event is broadcast when a route change is prevented, because the user is not logged in.

Use this event if you want to implement your own strategy for presenting the user with a login form.

To receive this event, you must be using the ngRoute module.

Type:

broadcast

Target:

root scope

Parameters
Param Type Details
event Object
Angular event object.

toRoute Object
The route that the user attempted to access.

Example
```
$rootScope.$on('$routeChangeUnauthenticated', function(event, toRoute) {
  // Your custom logic for deciding how the user should login, and
  // if you want to redirect them to the desired route afterwards
});
```
$routeChangeUnauthorized
This event is broadcast when a route change is prevented, because the user is not authorized by the rules defined in the Stormpath Route Configuration for the requested route.

Use this event if you want to implement your own strategy for telling the user that they are forbidden from viewing that route.

To receive this event, you must be using the ngRoute module.

Type:

broadcast

Target:

root scope

Parameters
Param Type Details
event Object
Angular event object.

toRoute Object
The route that the user attempted to access.

Example
```
$rootScope.$on('$routeChangeUnauthorized', function(event, toRoute) {
  // Your custom logic for deciding how the user should be
  // notified that they are forbidden from this route
});
```
$stateChangeUnauthenticated
This event is broadcast when a UI state change is prevented, because the user is not logged in.

Use this event if you want to implement your own strategy for presenting the user with a login form.

To receive this event, you must be using the UI Router integration.

Type:

broadcast

Target:

root scope

Parameters
Param Type Details
event Object
Angular event object.

toState Object
The state that the user attempted to access.

toParams Object
The state params of the state that the user attempted to access.

Example
```
$rootScope.$on('$stateChangeUnauthenticated',function(e,toState,toParams){
  // Your custom logic for deciding how the user should login, and
  // if you want to redirect them to the desired state afterwards
});
```
$stateChangeUnauthorized
This event is broadcast when a UI state change is prevented, because the user is not authorized by the rules defined in the Stormpath State Configuration for the requested state.

Use this event if you want to implement your own strategy for telling the user that they are forbidden from viewing that state.

To receive this event, you must be using the UI Router integration.

Type:

broadcast

Target:

root scope

Parameters
Param Type Details
event Object
Angular event object.

toState Object
The state that the user attempted to access.

toParams Object
The state params of the state that the user attempted to access.

Example
```
$rootScope.$on('$stateChangeUnauthorized',function(e,toState,toParams){
  // Your custom logic for deciding how the user should be
  // notified that they are forbidden from this state
});
```

Param	Type	Details
event	Object	Angular event object.
toRoute	Object	The route that the user attempted to access.

$stormpath service in module stormpath

Description

Methods

ngRouter(config)

Parameters

Example

uiRouter(config)

Parameters

Example

Events

$routeChangeUnauthenticated

Type:

Target:

Parameters

Example

$routeChangeUnauthorized

Type:

Target:

Parameters

Example

$stateChangeUnauthenticated

Type:

Target:

Parameters

Example

$stateChangeUnauthorized

Type:

Target:

Parameters

Example

`$stormpath`
service in module `stormpath`