Package io.github.coho04.githubapi.entities

Class GHPages

java.lang.Object
io.github.coho04.githubapi.bases.GHBase
io.github.coho04.githubapi.entities.GHPages
All Implemented Interfaces:
HttpRequestInterface, JSONHelper
public class GHPages extends GHBase
Represents the GitHub Pages configuration for a repository. This class provides methods and properties to access information about the GitHub Pages configuration.

  • Constructor Details

    • GHPages

      public GHPages(org.json.JSONObject jsonObject)
      Constructs a new GHPages instance with the provided JSON object.
      Parameters:
      jsonObject - the JSON object containing the GitHub Pages data

  • Method Details

    • getUrl

      public String getUrl()
      Returns the URL of the GitHub Pages site.
      Returns:
      the URL of the GitHub Pages site

    • getHttpsCertificate

      public HttpsCertificate getHttpsCertificate()
      Returns the HTTPS certificate information for the GitHub Pages site.
      Returns:
      the HTTPS certificate information

    • getSource

      public org.json.JSONObject getSource()
      Returns the source configuration for the GitHub Pages site.
      Returns:
      the source configuration as a JSONObject

    • getPendingDomainUnverifiedAt

      public OffsetDateTime getPendingDomainUnverifiedAt()
      Returns the date and time when the domain was pending verification.
      Returns:
      the date and time when the domain was pending verification

    • getCname

      public String getCname()
      Returns the CNAME for the GitHub Pages site.
      Returns:
      the CNAME for the GitHub Pages site

    • getHtmlUrl

      public String getHtmlUrl()
      Returns the HTML URL of the GitHub Pages site.
      Returns:
      the HTML URL of the GitHub Pages site

    • getProtectedDomainState

      public String getProtectedDomainState()
      Returns the protected domain state of the GitHub Pages site.
      Returns:
      the protected domain state

    • getStatus

      public String getStatus()
      Returns the status of the GitHub Pages site.
      Returns:
      the status of the GitHub Pages site

    • isCustom404

      public boolean isCustom404()
      Returns whether a custom 404 page is used for the GitHub Pages site.
      Returns:
      true if a custom 404 page is used, false otherwise

    • isHttpsEnforced

      public boolean isHttpsEnforced()
      Returns whether HTTPS is enforced for the GitHub Pages site.
      Returns:
      true if HTTPS is enforced, false otherwise

    • isPublic

      public boolean isPublic()
      Returns whether the GitHub Pages site is public.
      Returns:
      true if the site is public, false otherwise