HockeyAppUploadSettings Class

Summary

Contains settings used by Cake.HockeyApp.Internal.HockeyAppClient For a detailed information look at the official API Documentation
Assembly
Cake.HockeyApp.dll
Namespace
Cake.HockeyApp
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["HockeyAppUploadSettings"] class Type type-node

Syntax

public class HockeyAppUploadSettings

Constructors

Properties

Name Value Summary
ApiBaseUrl string
Gets or sets the base URL for connection to the HockeyApp api. Default is https://rink.hockeyapp.net
ApiToken string
Gets or sets the token used for authentication. If the token is not set it is loaded from the HOCKEYAPP_API_TOKEN environment variable.
AppId string
Gets or sets the application id. This is a required property if you don't upload an apk or ipa. You can only upload packages to apps you have created before.
BuildServerUrl string
Gets or sets the build server url this version origins. Optional.
CommitSha string
Gets or sets the commit sha this version refers. Optional.
Mandatory Nullable<MandatoryOption>
Gets or sets the mandatory option for this version. Optional.
Notes string
Gets or sets release notes for this version. Optional.
NoteType Nullable<NoteType>
Gets or sets the type of notes. Either Plain Text or Markdown. Optional.
Notify Nullable<NotifyOption>
Gets or sets the notify option declaring who has to be notified. Optional.
OwnerId string
Gets or sets the owner id. Optional. You need a full access api token for this operation.
Private Nullable<bool>
Gets or sets if this is a private version. Optional.
ReleaseType Nullable<ReleaseType>
Gets or sets the release type for this version. Optional. Default is Beta.
RepositoryUrl string
Gets or sets the repository url this version origins. Optional.
ShortVersion string
Gets or sets the short version. This is a userfriendly alias for Version
Status Nullable<DownloadStatus>
Gets or sets the download status declaring if this version can be downloaded. Optional.
Tags string[]
Gets or sets tags belonging to this version. Optional.
Teams int[]
Gets or sets the teams this version is restricted to. Optional. You need to specify the team ids.
Users int[]
Gets or sets the users this version is restricted to. Optional. You need to specify the user ids.
Version string
Gets or sets the version tag. This is a required property if you don't upload an apk or ipa.

Extension Methods

Name Value Summary
Dump<HockeyAppUploadSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<HockeyAppUploadSettings>(HockeyAppUploadSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<HockeyAppUploadSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<HockeyAppUploadSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<HockeyAppUploadSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<HockeyAppUploadSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin