Hilfe-Center
  1. Startseite
  2. Technische Referenz
  3. API
  4. API-Funktionen
  5. Pages

Pages

Beinhaltet allgemeine seitenbezogene Funktionen, die keiner bestimmten Seite zugeordnet werden können.

 Function GetStartPage(Page As iPage, EditMode As Boolean) As iPage

Liefert die Startseite anhand der übergebenen Page

  • Page: Entspricht der Seite von welcher wir die Startseite haben wollen
  • EditMode: true wenn noch nicht veröffentlicht, false wenn bereits veröffentlicht
Copy

API.Pages.GetStartPage(Page, True)

Function GetStartPage(Language As iLanguage, EditMode As Boolean) As iPage [V2]

Liefert die Startseite anhand der Sprache

  • Language: Gibt die Sprache an in welche die gesuchte Seite sein soll
  • EditMode: true wenn noch nicht veröffentlicht, false wenn bereits veröffentlicht
Copy

API.Pages.GetStartPage(PageLanguageID, EditMode)

Function GetByID(ID As Integer, EditMode As Boolean) As iPage [V2]

Liefert die gesuchte Seite 

  • ID: Die ID der Page
  • EditMode: true wenn noch nicht veröffentlicht, false wenn bereits veröffentlicht
Copy

API.Pages.GetByID(PageID, True)

Function GetByNavigation(
    Navigation As iNavigation,
    Language As iLanguage,
    EditMode As Boolean
) As iPage [V2]

Liefert alle Seiten einer Navigation

  • Navigation: Das Objekt der Navigation
  • Language: Das Objekt der Sprache in der die Navigation liegt
  • EditMode: true wenn noch nicht veröffentlicht, false wenn bereits veröffentlicht
Copy

API.Pages.GetByNavigation(Navigation, Language, True)

GetByType(
    TypeName As String,
    EditMode As Boolean,
    Optional Language As iLanguage = Nothing,
    Optional WithInvisible As Boolean = False,
    Optional NavigationName As String = "",
    Optional UserID As Integer = 0
) As IEnumerable(Of iPage) [V2]

Liefert alle Seiten eines bestimmten Seitentyps, wobei die Reihenfolge der entspricht, wie man sie im Baum sieht.
Wird keine Sprach-ID übergeben, bzw. ist sie kleiner gleich 0, werden alle Seiten aus allen Sprachen gefunden.

  • Type: Der Name des gesuchten ShapeTypes
  • EditMode: true wenn noch nicht veröffentlicht, false wenn bereits veröffentlicht
  • Optionale Paramenter
    • Language: Das Objektder Sprache; Falls nicht angegeben, werden alle Sprachen durchsucht
    • WithUnpublished: Gibt an, ob auch Seiten mitgeliefert werden sollen, die derzeit keinen veröffentlichten Stand haben
    • WithInvisible: Falls True, werden auch unsichtbare Seiten gefunden (Default False)
    • NavigationName: Schränkt das Ergebnis auf die angegebene Navigation ein
    • UserID: Gibt den User an, an den die Seite zugeordnet wurde. Es werden dann alle Seiten gefunden, der der Benutzer zugeordnet ist, sowohl direkt als auch über Gruppenbeziehungen.
Copy

API.Pages.GetByType("EventList", EditMode, Language:=API.Languages.GetByID(1, EditMode), WithInvisible:=True)

GetByType(
    Type As iPageType,
    EditMode As Boolean,
    Optional Language As iLanguage = Nothing,
    Optional WithInvisible As Boolean = False,
    Optional NavigationName As String = "",
    Optional UserID As Integer = 0
) As IEnumerable(Of iPage)

Liefert alle Seiten eines bestimmten Seitentyps, wobei die Reihenfolge der entspricht, wie man sie im Baum sieht.
Wird keine Sprach-ID übergeben, bzw. ist sie kleiner gleich 0, werden alle Seiten aus allen Sprachen gefunden.

  • Type: Das Objekt des Seitentyps nachdem gesucht werden soll
  • EditMode: true wenn noch nicht veröffentlicht, false wenn bereits veröffentlicht
  • Optionale Paramenter
    • Language: Das Objektder Sprache; Falls nicht angegeben, werden alle Sprachen durchsucht
    • WithUnpublished: Gibt an, ob auch Seiten mitgeliefert werden sollen, die derzeit keinen veröffentlichten Stand haben
    • WithInvisible: Falls True, werden auch unsichtbare Seiten gefunden (Default False)
    • NavigationName: Schränkt das Ergebnis auf die angegebene Navigation ein
    • UserID: Gibt den User an, an den die Seite zugeordnet wurde. Es werden dann alle Seiten gefunden, der der Benutzer zugeordnet ist, sowohl direkt als auch über Gruppenbeziehungen.
Copy

API.Pages.GetByType(API.PageTypes.GetByName("EventList"), EditMode, Language:=API.Languages.GetByID(1, EditMode), WithInvisible:=True)

GetByType(
    TypeNames As IEnumerable(Of String),
    EditMode As Boolean,
    Optional Language As iLanguage = Nothing,
    Optional WithInvisible As Boolean = False,
    Optional NavigationName As String = "",
    Optional UserID As Integer = 0
) As IEnumerable(Of iPage) [V2]

Liefert alle Seiten eines bestimmten Seitentyps, wobei die Reihenfolge der entspricht, wie man sie im Baum sieht.
Wird keine Sprach-ID übergeben, bzw. ist sie kleiner gleich 0, werden alle Seiten aus allen Sprachen gefunden.

  • Types: Liste von Namen der Seitentypen nach denen gesucht werden sollen
  • EditMode: true wenn noch nicht veröffentlicht, false wenn bereits veröffentlicht
  • Optionale Parameter
    • Language: Das Objektder Sprache; Falls nicht angegeben, werden alle Sprachen durchsucht
    • WithUnpublished: Gibt an, ob auch Seiten mitgeliefert werden sollen, die derzeit keinen veröffentlichten Stand haben
    • WithInvisible: Falls True, werden auch unsichtbare Seiten gefunden (Default False)
    • NavigationName: Schränkt das Ergebnis auf die angegebene Navigation ein
    • UserID: Gibt den User an, an den die Seite zugeordnet wurde. Es werden dann alle Seiten gefunden, der der Benutzer zugeordnet ist, sowohl direkt als auch über Gruppenbeziehungen.
Copy

API.Pages.GetByType({"EventList", "ActivityList"}, EditMode, Language:=API.Languages.GetByID(1, EditMode), WithInvisible:=True)

GetByType(
    Types As IEnumerable(Of iPageType),
    EditMode As Boolean,
    Optional Language As iLanguage = Nothing,
    Optional WithInvisible As Boolean = False,
    Optional NavigationName As String = "",
    Optional UserID As Integer = 0
) As IEnumerable(Of iPage) [V2]

Liefert alle Seiten eines bestimmten Seitentyps, wobei die Reihenfolge der entspricht, wie man sie im Baum sieht.
Wird keine Sprach-ID übergeben, bzw. ist sie kleiner gleich 0, werden alle Seiten aus allen Sprachen gefunden.

  • Types: Liste von Objekten der Seitentypen nach denen gesucht werden sollen
  • EditMode: true wenn noch nicht veröffentlicht, false wenn bereits veröffentlicht
  • Optionale Parameter
    • Language: Das Objektder Sprache; Falls nicht angegeben, werden alle Sprachen durchsucht
    • WithUnpublished: Gibt an, ob auch Seiten mitgeliefert werden sollen, die derzeit keinen veröffentlichten Stand haben
    • WithInvisible: Falls True, werden auch unsichtbare Seiten gefunden (Default False)
    • NavigationName: Schränkt das Ergebnis auf die angegebene Navigation ein
    • UserID: Gibt den User an, an den die Seite zugeordnet wurde. Es werden dann alle Seiten gefunden, der der Benutzer zugeordnet ist, sowohl direkt als auch über Gruppenbeziehungen.
Copy

API.Pages.GetByType({API.PageTypes.GetByName("EventList"), API.PageTypes.GetByName("ActivityList")}, EditMode, Language:=API.Languages.GetByID(1, EditMode), WithInvisible:=True)

GetByAttributeValueName(
    AttributeName As String,
    EditMode As Boolean,
    Optional Language As iLanguage = Nothing,
    Optional WithInvisible As Boolean = False,
    Optional Value As Object = Nothing
) As IEnumerable(Of iPage) [V2]

Liefert alle Seiten die ein bestimmtes Attribut enthalten, wobei die Reihenfolge der entspricht, wie man sie im Baum sieht.

  • AttributeName: Name des Attribut-Feldes
  • EditMode: Boolean Wert der angibt ob die Seite veröffentlicht ist oder nicht
  • Optionale Parameter
    • Language: Das Objektder Sprache; Falls nicht angegeben, werden alle Sprachen durchsucht
    • WithInvisible: Falls True, werden auch unsichtbare Seiten gefunden (Default False)
    • Value: Falls nicht Nothing, werden nur die Seiten angegeben mit dem AttributeName, das auch den Wert der Value enthält (Default Nothing)
Copy

API.Pages.GetByAttributeName("MyInteger", True, WithInvisible:=True, Language:=API.Languages.GetByID(1, EditMode), Value:=42)

Create(
    Name As String,
    Type As iPageType,
    Parent As iPage,
    Modifier As iPerson,
    Optional Rank As Integer = 0,
    Optional ReferencePage As iPage = Nothing,
    Optional IgnoreLoginRequired As Boolean = False
) As PageCreateResult

Legt eine neue Seite unter einer bestimmten Seite an.
Ist die Seite an der Stelle nicht erlaubt, wird als Status des Rückgabe-Objekts "Failed" geliefert. Ist ein benötigter Parameter nicht gültig, wird "InvalidValue" geliefert.

  • Name: Der Name der neuen Seite
  • Type: Der Typ der neuen Seite
  • Parent: Die Elternseite, in der die neue Seite liegt
  • Modifier: Die ausführende Person
  • Optionale Parameter
    • Rank: Der Rang der neuen Seite (Bei ungültiger Angabe wird immer an letzte Position eingefügt)
    • ReferencePage: Die Seite, mit der die neue Seite verknüpft werden soll (Sprachverknüpfung)
    • IgnoreLoginRequired: (Default = False) Falls True, wird "Login required" der Parentseite nicht übernommen. Hat die anzulegende Seite die Einstellung ProtectByDefault in der Config stehen, wird sie, wenn IgnoreLoginRequired True ist, dennoch ohne Login required angelegt.
Copy

API.Pages.Create("Neue Seite", MyPageType, MyParent, CurrentUser, Rank:=3)

Create(
    Name As String,
    Type As iPageType,
    Navigation As iNavigation,
    Language As iLanguage,
    Modifier As iPerson,
    Optional Rank As Integer = 0,
    Optional ReferencePage As iPage = Nothing,
    Optional IgnoreLoginRequired As Boolean = False
) As PageCreateResult

Legt eine neue Seite auf erster Ebene in einer Navigation an.
Ist die Seite an der Stelle nicht erlaubt, wird als Status des Rückgabe-Objekts "Failed" geliefert. Ist ein benötigter Parameter nicht gültig, wird "InvalidValue" geliefert.

  • Name: Der Name der neuen Seite
  • Type: Der Typ der neuen Seite
  • Navigation: Die Navigation, in der die neue Seite liegt
  • Language: Die Sprache zu der die neue Seite gehört
  • Modifier: Die ausführende Person
  • Optionale Paramenter
    • Rank: Der Rang der neuen Seite (Bei ungültiger Angabe wird immer an letzte Position eingefügt)
    • ReferencePage: Die Seite, mit der die neue Seite verknüpft werden soll (Sprachverknüpfung)IgnoreLoginRequired - (Default = False) Falls True, wird "Login required" der Parentseite nicht übernommen. Hat die anzulegende Seite die Einstellung ProtectByDefault in der Config stehen, wird sie, wenn IgnoreLoginRequired True ist, dennoch ohne Login required angelegt.
    • IgnoreLoginRequired: (Default = False) Falls True, wird "Login required" der Parentseite nicht übernommen. Hat die anzulegende Seite die Einstellung ProtectByDefault in der Config stehen, wird sie, wenn IgnoreLoginRequired True ist, dennoch ohne Login required angelegt.
Copy

API.Pages.Create("Neue Seite", MyPageType, MyNavigation, MyLanguage, CurrentUser)

MultiPublish(PageList As IEnumerable(Of iPage), Modifier As iPerson) As MultiPublishResult [V2]

Führt einen Publish auf die in der Liste angegebenen Seiten aus.

Es wird ein Gesamtergebnis und eine Liste der Einzelergebnisse zurückgegeben.

  • PageList: Liste der Seiten, die veröffentlich werden sollen
  • Modifier: Person, welche die Veröffentlichung vornimmt
Copy

Dim PageList As New List(Of iPage)
PageList.Add(ContentPageObject)
PageList.Add(PageObject)

API.Pages.MultiPublish(PageList, CurrentUser)

War dieser Beitrag hilfreich?
1 von 1 fanden dies hilfreich.
Schade! Bitte teilen Sie uns doch mit was Ihnen nicht weitergeholfen hat.
Es ist ein technisches Problem aufgetreten. Bitte wenden Sie sich telefonisch oder per E-Mail an uns.