{ "id": "api/common/LocationStrategy", "title": "LocationStrategy", "contents": "\n\n
\n
\n
\n \n API > @angular/common\n
\n
\n mode_edit\n code\n
\n
\n \n
\n

LocationStrategylink

\n \n \n \n \n \n
\n \n \n\n
\n \n
\n

Enables the Location service to read route state from the browser's URL.\nAngular provides two strategies:\nHashLocationStrategy and PathLocationStrategy.

\n\n

See more...

\n
\n \n \n \n
\n\nabstract class LocationStrategy {\n abstract path(includeHash?: boolean): string\n abstract prepareExternalUrl(internal: string): string\n abstract pushState(state: any, title: string, url: string, queryParams: string): void\n abstract replaceState(state: any, title: string, url: string, queryParams: string): void\n abstract forward(): void\n abstract back(): void\n abstract onPopState(fn: LocationChangeListener): void\n abstract getBaseHref(): string\n}\n\n\n \n \n
\n

Subclasseslink

\n \n\n\n\n\n
\n \n\n
\n\n\n \n\n \n \n
\n

Descriptionlink

\n

Applications should use the Router or Location services to\ninteract with application route state.

\n

For instance, HashLocationStrategy produces URLs like\nhttp://example.com#/foo,\nand PathLocationStrategy produces\nhttp://example.com/foo as an equivalent URL.

\n

See these two classes for more.

\n\n \n
\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Methodslink

\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n path()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n abstract path(includeHash?: boolean): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n includeHash\n boolean\n

Optional. Default is undefined.

\n \n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n prepareExternalUrl()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n abstract prepareExternalUrl(internal: string): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n internal\n string\n \n \n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n pushState()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n abstract pushState(state: any, title: string, url: string, queryParams: string): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n state\n any\n \n \n
\n \n title\n string\n \n \n
\n \n url\n string\n \n \n
\n \n queryParams\n string\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n replaceState()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n abstract replaceState(state: any, title: string, url: string, queryParams: string): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n state\n any\n \n \n
\n \n title\n string\n \n \n
\n \n url\n string\n \n \n
\n \n queryParams\n string\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n forward()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n abstract forward(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n back()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n abstract back(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n onPopState()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n abstract onPopState(fn: LocationChangeListener): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n fn\n LocationChangeListener\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n getBaseHref()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n abstract getBaseHref(): string\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n
\n\n\n\n \n\n\n
\n
\n\n\n" }