A website served by Kademi, holding the DNS name it answers to and, as a Repository, the versioned content it publishes. A website is reached either by the domain name set explicitly on this row, which must be unique across the whole system, or by its name combined with the platform's primary domain. One website can be made an alias of another, in which case both names serve exactly the same content, or it can be pointed at a different address with redirectTo. The email columns, the DKIM selector and private key, the mail server and the MAIL FROM subdomain, are used when the platform sends mail on this site's behalf. Deleting a website normally soft deletes it, which renames it and clears its domain name so the name and DNS entry can be reused.
Group: Database Entities
Extends: Repository
Implements: VfsAcceptor, PortableId
Properties
| Property | Returns | Description |
|---|---|---|
| aliasTo | Website | The website this one is an alias for. Visitors see exactly the same content on both names, which is how a local domain name can sit alongside an externally delegated one. The lookup helpers follow these links, so a chain of aliases resolves to the website that really holds the content. Null for an ordinary website. |
| cdnName | String | Name of the CDN distribution serving this site's static content when a CDN is enabled. Null when content is served directly. |
| dkimPrivateKey | String | The private half of the DKIM key pair used to sign email sent from this site, up to 2000 characters. Treat it as a secret: it must never be rendered into a page or returned from an API. |
| dkimSelector | String | The DKIM selector published in DNS alongside the public key, naming which key a recipient should verify this site's mail signatures against. |
| domainName | String | The DNS name this website answers to, for example www.example.com. It is unique across the whole system, and is null for a website reached only through its name plus the platform's primary domain, or for one that has been soft deleted. |
| emailSubdomain | String | The MAIL FROM subdomain used when sending email from this site, for example em13412. Null if one has not been provisioned. |
| imageHash | String | Content hash of the thumbnail image stored for this site, used to fetch the preview shown in site listings. Null when no thumbnail has been generated. |
| mailServer | String | Host name used when sending email for this site and when generating its MX records. Null to use the platform default. |
| redirectTo | String | Address that requests to this website are redirected to. Unlike an alias, which serves the same content under both names, a redirect sends the visitor somewhere else. Null when the site serves its own content. |
| repoType | String | The repository type discriminator for a website, always the string W. It is what distinguishes a website from other repository kinds such as a calendar. |
Methods
getRepoType() · getDomainName() · getAliasTo() · getRedirectTo() · getDkimPrivateKey() · getDkimSelector() · getMailServer() · getImageHash() · getCdnName() · getEmailSubdomain()
getRepoType()
Returns: String
The repository type discriminator for a website, always the string W. It is what distinguishes a website from other repository kinds such as a calendar.
getDomainName()
Returns: String
The DNS name this website answers to, for example www.example.com. It is unique across the whole system, and is null for a website reached only through its name plus the platform's primary domain, or for one that has been soft deleted.
getAliasTo()
Returns: Website
The website this one is an alias for. Visitors see exactly the same content on both names, which is how a local domain name can sit alongside an externally delegated one. The lookup helpers follow these links, so a chain of aliases resolves to the website that really holds the content. Null for an ordinary website.
getRedirectTo()
Returns: String
Address that requests to this website are redirected to. Unlike an alias, which serves the same content under both names, a redirect sends the visitor somewhere else. Null when the site serves its own content.
getDkimPrivateKey()
Returns: String
The private half of the DKIM key pair used to sign email sent from this site, up to 2000 characters. Treat it as a secret: it must never be rendered into a page or returned from an API.
getDkimSelector()
Returns: String
The DKIM selector published in DNS alongside the public key, naming which key a recipient should verify this site's mail signatures against.
getMailServer()
Returns: String
Host name used when sending email for this site and when generating its MX records. Null to use the platform default.
getImageHash()
Returns: String
Content hash of the thumbnail image stored for this site, used to fetch the preview shown in site listings. Null when no thumbnail has been generated.
getCdnName()
Returns: String
Name of the CDN distribution serving this site's static content when a CDN is enabled. Null when content is served directly.
getEmailSubdomain()
Returns: String
The MAIL FROM subdomain used when sending email from this site, for example em13412. Null if one has not been provisioned.