Skip to content

Commit

Permalink
Update API docs links to fit the new versions
Browse files Browse the repository at this point in the history
  • Loading branch information
jmayntzhusen committed May 1, 2019
1 parent c0a3e9f commit fa5763d
Show file tree
Hide file tree
Showing 31 changed files with 147 additions and 43 deletions.
2 changes: 1 addition & 1 deletion Extending/Backoffice-UI-API-Documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ needsV8Update: "true"

A library of API Reference documentation is auto-generated from the comments within the Umbraco Source Code.

## [Backoffice UI](https://our.umbraco.com/apidocs/ui/#/api/)
## [Backoffice UI](https://our.umbraco.com/apidocs/v8/ui/#/api/)

Angular, JavaScript, CSS & Less UI API references for building Umbraco backoffice components.

Expand Down
2 changes: 1 addition & 1 deletion Extending/Property-Editors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Property editors can be configured to support tag data. In v7 the tag system has

### More information
- [Built in Property Editors](../../Getting-Started/Backoffice/Property-Editors/Built-in-Property-Editors/)
- The full [Umbraco Backoffice UI API documentation](../../../apidocs/ui/) for all the angular services, directives and resources.
- The full [Umbraco Backoffice UI API documentation](../../../apidocs/v8/ui/) for all the angular services, directives and resources.

### Umbraco TV
- Chapter: [Property Editors](https://umbraco.tv/videos/umbraco-v7/developer/extending/property-editors/)
2 changes: 1 addition & 1 deletion Extending/Section-Trees/trees-v7.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Our Tree Action View would then be wired to the loaded controller using the ng-c
</div>
```

Take a look at the [umbEditor directives in the backoffice API Documentation](https://our.umbraco.com/apidocs/ui/#/api/umbraco.directives.directive:umbEditorHeader), for lots of common interaction directives that can be used to deliver a consistent backoffice editing experience for items in your custom tree.
Take a look at the [umbEditor directives in the backoffice API Documentation](https://our.umbraco.com/apidocs/v7/ui/#/api/umbraco.directives.directive:umbEditorHeader), for lots of common interaction directives that can be used to deliver a consistent backoffice editing experience for items in your custom tree.
[see Tree Actions for a list of tree *ActionMenuItems* and *IActions*](tree-actions.md)

Expand Down
2 changes: 1 addition & 1 deletion Extending/Section-Trees/trees.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Our Tree Action View would then be wired to the loaded controller using the ng-c
![Delete Raindrops on Roses](images/delete-raindrops-on-roses-v8.png)


Take a look at the [umbEditor directives in the backoffice API Documentation](https://our.umbraco.com/apidocs/ui/#/api/umbraco.directives.directive:umbEditorHeader), for lots of common interaction directives that can be used to deliver a consistent backoffice editing experience for items in your custom tree.
Take a look at the [umbEditor directives in the backoffice API Documentation](https://our.umbraco.com/apidocs/v8/ui/#/api/umbraco.directives.directive:umbEditorHeader), for lots of common interaction directives that can be used to deliver a consistent backoffice editing experience for items in your custom tree.
[see Tree Actions for a list of tree *ActionMenuItems* and *IActions*](tree-actions.md)

Expand Down
29 changes: 29 additions & 0 deletions Reference/API-Documentation/index-v7.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
versionFrom: 7.0.0
---

# API Documentation

A library of API Reference documentation is auto-generated from the comments within the Umbraco Source Code.

## C# API Documentation

C# API references for the Umbraco Core and Web libraries.

### [Umbraco.Core](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.html)
### [Umbraco.Web](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Web.html)

__Note: opens a documentation browser that is different from the documentation section you're viewing now.__

## Backoffice UI API Documentation

Angular, JavaScript, CSS & Less UI API references for building Umbraco backoffice components.

- umbraco.directives
- umbraco.services
- umbraco.resources

### [Backoffice UI](https://our.umbraco.com/apidocs/v7/ui/#/api/)

__Note: opens a documentation browser that is different from the documentation section you're viewing now.__

9 changes: 4 additions & 5 deletions Reference/API-Documentation/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
versionFrom: 7.0.0
needsV8Update: "true"
versionFrom: 8.0.0
---

# API Documentation
Expand All @@ -11,8 +10,8 @@ A library of API Reference documentation is auto-generated from the comments wit

C# API references for the Umbraco Core and Web libraries.

### [Umbraco.Core](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.html)
### [Umbraco.Web](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Web.html)
### [Umbraco.Core](https://our.umbraco.com/apidocs/v8/csharp/api/Umbraco.Core.html)
### [Umbraco.Web](https://our.umbraco.com/apidocs/v8/csharp/api/Umbraco.Web.html)

__Note: opens a documentation browser that is different from the documentation section you're viewing now.__

Expand All @@ -24,7 +23,7 @@ Angular, JavaScript, CSS & Less UI API references for building Umbraco backoffic
- umbraco.services
- umbraco.resources

### [Backoffice UI](https://our.umbraco.com/apidocs/ui/#/api/)
### [Backoffice UI](https://our.umbraco.com/apidocs/v8/ui/#/api/)

__Note: opens a documentation browser that is different from the documentation section you're viewing now.__

8 changes: 4 additions & 4 deletions Reference/Events/Application-Startup-v7.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In order to bind to certain events in the Umbraco application you need to make t
Applies to: Umbraco 6.1.0+
:::

The [ApplicationEventHandler](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.ApplicationEventHandler.html) is a plugin type that allows developers to execute code during the Umbraco bootup process.
The [ApplicationEventHandler](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.ApplicationEventHandler.html) is a plugin type that allows developers to execute code during the Umbraco bootup process.

This is the preferred way to hook in to the Umbraco application startup process. It is a base class so all you need to do is override the methods that you wish to handle. It is important to know the difference between each of the methods (information is below). Almost always, you just want to use the __ApplicationStarted__ method.

Expand Down Expand Up @@ -99,11 +99,11 @@ If you want more control over execution you can override these properties:

Handlers are ordered by (ascending) weight. By default, handlers from the Umbraco.* assemblies have a -100 weight whereas any other handler has a weight of +100.

A custom weight can be assigned to a handler by marking the class with the [WeightAttribute](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.ObjectResolution.WeightAttribute.html). Positive weights are considered "user-space" while negative weights are "core".
A custom weight can be assigned to a handler by marking the class with the [WeightAttribute](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.ObjectResolution.WeightAttribute.html). Positive weights are considered "user-space" while negative weights are "core".

For example, the [CacheRefresherEventHandler](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Web.Cache.CacheRefresherEventHandler.html) is marked with `Weight(int.MinValue)` because its events need to run before anything else.
For example, the [CacheRefresherEventHandler](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Web.Cache.CacheRefresherEventHandler.html) is marked with `Weight(int.MinValue)` because its events need to run before anything else.

Finally (very EXPERT), users can [register a filter](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.ObjectResolution.ApplicationEventsResolver.html#Umbraco_Core_ObjectResolution_ApplicationEventsResolver_FilterCollection) to process the list (after it has been ordered) and re-order it, or remove handlers.
Finally (very EXPERT), users can [register a filter](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.ObjectResolution.ApplicationEventsResolver.html#Umbraco_Core_ObjectResolution_ApplicationEventsResolver_FilterCollection) to process the list (after it has been ordered) and re-order it, or remove handlers.

:::warning
Handlers order is an important thing, and removing handlers or reordering handlers can have unexpected consequences.
Expand Down
2 changes: 1 addition & 1 deletion Reference/Events/Extending-UmbracoApplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ needsV8Update: "true"

## Binding to HttpApplication events

It is not necessary to override and replace the [UmbracoApplication](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Web.UmbracoApplication.html). If you consider changing the default `global.asax`, read on!
It is not necessary to override and replace the [UmbracoApplication](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Web.UmbracoApplication.html). If you consider changing the default `global.asax`, read on!

Umbraco allows you to bind directly to HttpApplication events which is very handy since normally you would require an HttpModule to bind to these types of events.

Expand Down
6 changes: 3 additions & 3 deletions Reference/Events/Understanding-Bootmanagers.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ needsV8Update: "true"

After IIS started the W3 process, Umbraco will begin launching. There is a bootstrapper for the `Umbraco Application` which initializes all objects.

The responsible objects for the startup are the [CoreBootManager](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.CoreBootManager.html) and [WebBootManager](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Web.WebBootManager.html) where the latter includes the Web portion of the application.
The responsible objects for the startup are the [CoreBootManager](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.CoreBootManager.html) and [WebBootManager](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Web.WebBootManager.html) where the latter includes the Web portion of the application.

The boot managers initialize the [UmbracoApplication](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Web.UmbracoApplication.html) (the global.asax) object. After it has initialized the UmbracoApplication, it will initialize the ApplicationContext.
The boot managers initialize the [UmbracoApplication](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Web.UmbracoApplication.html) (the global.asax) object. After it has initialized the UmbracoApplication, it will initialize the ApplicationContext.

The bootmanager will initialize the ApplicationContext with: the database context, services context, profiling and logger. It will also register the Application Startup handlers which will execute later using the [ApplicationEventsResolver](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.ObjectResolution.ApplicationEventsResolver.html).
The bootmanager will initialize the ApplicationContext with: the database context, services context, profiling and logger. It will also register the Application Startup handlers which will execute later using the [ApplicationEventsResolver](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.ObjectResolution.ApplicationEventsResolver.html).

For those wondering: **Examine actually doesn't do anything on startup - 'if the indexes are built'**

Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Models/Relation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ All samples in this document will require the following using statement:

## Code reference

More information about this object can be found in the [Relation Model Core documentation](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Models.Relation.html)
More information about this object can be found in the [Relation Model Core documentation](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Models.Relation.html)
4 changes: 2 additions & 2 deletions Reference/Management/Services/ConsentService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ needsV8Update: "true"

**Applies to Umbraco 7.9 and newer**

[Browse the API documentation for ConsentService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.IConsentService.html).
[Browse the API documentation for ConsentService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.IConsentService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand All @@ -23,7 +23,7 @@ Consent can be given or revoked or changed via the `RegisterConsent` method, whi
creates a new `Consent` entity to track the consent.

## Get the current state
Getter methods of this service return the current state of a consent, i.e. the latest [IConsent](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Models.IConsent.html)
Getter methods of this service return the current state of a consent, i.e. the latest [IConsent](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Models.IConsent.html)
entity that was created.

## Revoking a consent
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/ContentService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Applies to Umbraco 6.0.0+

The ContentService acts as a "gateway" to Umbraco data for operations which are related to Content.

[Browse the API documentation for ContentService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.ContentService.html).
[Browse the API documentation for ContentService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.ContentService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/ContentTypeService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ needsV8Update: "true"

The content type service acts as a "gateway" to Umbraco data for operations which are related to both content types and media types.

[Browse the API documentation for ContentTypeService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.ContentTypeService.html).
[Browse the API documentation for ContentTypeService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.ContentTypeService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/DataTypeService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ needsV8Update: "true"

The DataTypeService acts as a "gateway" to Umbraco data for operations which are related to DataTypes and DataTypeDefinitions.

[Browse the API documentation for DataTypeService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.DataTypeService.html).
[Browse the API documentation for DataTypeService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.DataTypeService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/DomainService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ needsV8Update: "true"

The domain service acts as a "gateway" to Umbraco data for operations which are related to domains.

[Browse the API documentation for DomainService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.DomainService.html).
[Browse the API documentation for DomainService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.DomainService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/FileService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Applies to Umbraco 6.0.0+

The FileService acts as a "gateway" to Umbraco data for operations which are related to Scripts, Stylesheets and Templates.

[Browse the API documentation for FileService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.FileService.html).
[Browse the API documentation for FileService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.FileService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/LocalizationService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Applies to Umbraco 6.0.0+

The LocalizationService acts as a "gateway" to Umbraco data for operations which are related to Dictionary items and Languages.

[Browse the API documentation for LocalizationService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.LocalizationService.html).
[Browse the API documentation for LocalizationService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.LocalizationService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The culture code is the friendly name of the language in Umbraco, which for the

The ISO code is a combination of the two-letter ISO 639-1 language code (lowercase) and two-letter ISO-3166 country code (uppercase). Eg. `en-US` for English in the United States, `en-GB` for English in the United Kingdom and `da-DK` for Danish in Denmark.

All three methods will return an instance of the [ILanguage](https://our.umbraco.org/apidocs/csharp/api/Umbraco.Core.Models.ILanguage.html) interface, which has traditional properties like `Id` and `Key`, but also properties specific to the language like `CultureName`, `CultureInfo` and `IsoCode`. You can see the API reference for further information on the properties of the interface.
All three methods will return an instance of the [ILanguage](https://our.umbraco.org/apidocs/v7/csharp/api/Umbraco.Core.Models.ILanguage.html) interface, which has traditional properties like `Id` and `Key`, but also properties specific to the language like `CultureName`, `CultureInfo` and `IsoCode`. You can see the API reference for further information on the properties of the interface.

### Getting all languages

Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/MediaService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Applies to Umbraco 6.0.0+

The MediaService acts as a "gateway" to Umbraco data for operations which are related to Media.

[Browse the API documentation for MediaService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.MediaService.html).
[Browse the API documentation for MediaService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.MediaService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/MemberGroupService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Applies to Umbraco 6.2 and 7.1 and newer

The MemberGroupService acts as a "gateway" to Umbraco data for operations which are related to Member groups, which are also known as Member Roles.

[Browse the API documentation for MemberGroupService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.MemberGroupService.html).
[Browse the API documentation for MemberGroupService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.MemberGroupService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/MemberService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Applies to Umbraco 6.2 and 7.1 and newer

The MemberService acts as a "gateway" to Umbraco data for operations which are related to Members.

[Browse the API documentation for MemberService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.MemberService.html).
[Browse the API documentation for MemberService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.MemberService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/MemberTypeService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Applies to Umbraco 6.2 and 7.1 and newer

The MemberTypeService acts as a "gateway" to Umbraco data for operations which are related to MemberTypes.

[Browse the API documentation for MemberTypeService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.MemberTypeService.html).
[Browse the API documentation for MemberTypeService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.MemberTypeService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/RelationService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Applies to Umbraco 6.1.1 and newer

The RelationService acts as a "gateway" to Umbraco data for operations which are related to Relations.

[Browse the API documentation for RelationService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.RelationService.html).
[Browse the API documentation for RelationService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.RelationService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/SectionService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Applies to Umbraco 7.x and newer

The SectionService is used to control/query the storage for section registrations in the ~/Config/applications.config file.

[Browse the API documentation for ISectionService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.ISectionService.html).
[Browse the API documentation for ISectionService](https://our.umbraco.com//v7/csharp/api/Umbraco.Core.Services.ISectionService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
2 changes: 1 addition & 1 deletion Reference/Management/Services/TreeService/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ needsV8Update: "true"

The ApplicationTreeService is used to control/query the storage for tree registrations in the ~/Config/trees.config file.

[Browse the API documentation for IApplicationTreeService](https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.IApplicationTreeService.html).
[Browse the API documentation for IApplicationTreeService](https://our.umbraco.com/apidocs/v7/csharp/api/Umbraco.Core.Services.IApplicationTreeService.html).

* **Namespace:** `Umbraco.Core.Services`
* **Assembly:** `Umbraco.Core.dll`
Expand Down
Loading

0 comments on commit fa5763d

Please sign in to comment.