index.json

{
  "api-server/Octo_Server.User.html": {
    "href": "api-server/Octo_Server.User.html",
    "title": "Struct User | Octo - Documentation",
    "keywords": "Struct User Basic user struct containing username, password. Inherited Members System.ValueType.Equals(System.Object) System.ValueType.GetHashCode() System.ValueType.ToString() System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetType() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public struct User Fields | Improve this Doc View Source Password Declaration public string Password Field Value Type Description System.String | Improve this Doc View Source Username Declaration public string Username Field Value Type Description System.String"
  },
  "api-core/Octo.DirectoryNode.html": {
    "href": "api-core/Octo.DirectoryNode.html",
    "title": "Class DirectoryNode | Octo - Documentation",
    "keywords": "Class DirectoryNode A single node which may comprise a tree. Contains children and a reference to the parent object. Inheritance System.Object DirectoryNode Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class DirectoryNode Constructors | Improve this Doc View Source DirectoryNode() Blank constructor for manually creating a null node. Declaration public DirectoryNode() | Improve this Doc View Source DirectoryNode(String, String, DirectoryNode) Recursive search constructor, for normal usage. Declaration public DirectoryNode(string loc, string rootPath, DirectoryNode parent = null) Parameters Type Name Description System.String loc System.String rootPath DirectoryNode parent Fields | Improve this Doc View Source ChildFiles Declaration public List<string> ChildFiles Field Value Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source ChildFolders Declaration public List<DirectoryNode> ChildFolders Field Value Type Description System.Collections.Generic.List < DirectoryNode > | Improve this Doc View Source DirectoryName Declaration public string DirectoryName Field Value Type Description System.String | Improve this Doc View Source Parent Declaration public DirectoryNode Parent Field Value Type Description DirectoryNode"
  },
  "api-core/Octo.CollectionDiff.html": {
    "href": "api-core/Octo.CollectionDiff.html",
    "title": "Class CollectionDiff | Octo - Documentation",
    "keywords": "Class CollectionDiff Class that describes the difference between two collections, with utility methods. Inheritance System.Object CollectionDiff Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class CollectionDiff Constructors | Improve this Doc View Source CollectionDiff() Declaration public CollectionDiff() Fields | Improve this Doc View Source addedFiles Declaration public List<string> addedFiles Field Value Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source addedFolders Declaration public List<string> addedFolders Field Value Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source changedFiles Declaration public List<string> changedFiles Field Value Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source removedFiles Declaration public List<string> removedFiles Field Value Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source removedFolders Declaration public List<string> removedFolders Field Value Type Description System.Collections.Generic.List < System.String > Methods | Improve this Doc View Source ComputeDiff(DirectoryCollection, DirectoryCollection, Boolean) Calculates the diff between two directory collections, saves results to repoDiff. Declaration public static CollectionDiff ComputeDiff(DirectoryCollection self, DirectoryCollection comparator, bool noReturn = false) Parameters Type Name Description DirectoryCollection self The old collection to compare. DirectoryCollection comparator The new collection to compare. System.Boolean noReturn Returns Type Description CollectionDiff | Improve this Doc View Source GenerateManifest() Generates an Octo format manifest, which can be reparsed or saved to file. Declaration public string GenerateManifest() Returns Type Description System.String An octo manifest, as string."
  },
  "api-core/Octo.Repository.html": {
    "href": "api-core/Octo.Repository.html",
    "title": "Class Repository | Octo - Documentation",
    "keywords": "Class Repository Holds all files and change data for the project, as well as signing keys. Anything that is uploaded or downloaded directly from the server is held here. Inheritance System.Object Repository Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class Repository Constructors | Improve this Doc View Source Repository(String) Repository basic constructor, creates a vault, and sets location. Declaration public Repository(string loc) Parameters Type Name Description System.String loc Fields | Improve this Doc View Source Commits Declaration public Dictionary<ulong, string> Commits Field Value Type Description System.Collections.Generic.Dictionary < System.UInt64 , System.String > | Improve this Doc View Source DeltaVault Declaration public Vault DeltaVault Field Value Type Description Vault | Improve this Doc View Source Location Declaration public string Location Field Value Type Description System.String Properties | Improve this Doc View Source Version The \"Version\" property is simply a mirror for deltaVault.CurrentVersion. Declaration public ulong Version { get; set; } Property Value Type Description System.UInt64 Methods | Improve this Doc View Source CreateBackup(String) Creates a backup of the current repository. Declaration public void CreateBackup(string commitMessage) Parameters Type Name Description System.String commitMessage | Improve this Doc View Source RollBack() Rolls back to the previous version of the repository. Declaration public bool RollBack() Returns Type Description System.Boolean | Improve this Doc View Source WriteRepoConfig() Writes the generic repo config to the octo directory. Declaration public void WriteRepoConfig()"
  },
  "api-server/Octo_Server.Server.html": {
    "href": "api-server/Octo_Server.Server.html",
    "title": "Class Server | Octo - Documentation",
    "keywords": "Class Server Inheritance System.Object Server Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public class Server Constructors | Improve this Doc View Source Server() Declaration public Server() Fields | Improve this Doc View Source authhost Declaration public WebServiceHost authhost Field Value Type Description System.ServiceModel.Web.WebServiceHost | Improve this Doc View Source authservice_endpoint Declaration public ServiceEndpoint authservice_endpoint Field Value Type Description System.ServiceModel.Description.ServiceEndpoint | Improve this Doc View Source Hostname Declaration public string Hostname Field Value Type Description System.String | Improve this Doc View Source IP Declaration public string IP Field Value Type Description System.String | Improve this Doc View Source kp Declaration public static KeyPair kp Field Value Type Description KeyPair | Improve this Doc View Source octoservice_endpoint Declaration public ServiceEndpoint octoservice_endpoint Field Value Type Description System.ServiceModel.Description.ServiceEndpoint | Improve this Doc View Source Port Declaration public int Port Field Value Type Description System.Int32 | Improve this Doc View Source projecthost Declaration public WebServiceHost projecthost Field Value Type Description System.ServiceModel.Web.WebServiceHost | Improve this Doc View Source projectservice_endpoint Declaration public ServiceEndpoint projectservice_endpoint Field Value Type Description System.ServiceModel.Description.ServiceEndpoint | Improve this Doc View Source serviceBinding Declaration public static WebHttpBinding serviceBinding Field Value Type Description System.ServiceModel.WebHttpBinding | Improve this Doc View Source servicehost Declaration public WebServiceHost servicehost Field Value Type Description System.ServiceModel.Web.WebServiceHost | Improve this Doc View Source storagehost Declaration public WebServiceHost storagehost Field Value Type Description System.ServiceModel.Web.WebServiceHost | Improve this Doc View Source storagehost_endpoint Declaration public ServiceEndpoint storagehost_endpoint Field Value Type Description System.ServiceModel.Description.ServiceEndpoint | Improve this Doc View Source streamBinding Declaration public static WebHttpBinding streamBinding Field Value Type Description System.ServiceModel.WebHttpBinding Methods | Improve this Doc View Source ParseConfigFileAt(String) Loads and parses the config file at the given location. Declaration public void ParseConfigFileAt(string location) Parameters Type Name Description System.String location The file location (local to the exe) of the config. | Improve this Doc View Source Start() Starts the server, and opens the HTTPS endpoints. Declaration public void Start() | Improve this Doc View Source Stop() Stops the server, closing the HTTPS endpoints. Declaration public void Stop()"
  },
  "api-client/Octo_Client.ClientInfo.html": {
    "href": "api-client/Octo_Client.ClientInfo.html",
    "title": "Struct ClientInfo | Octo - Documentation",
    "keywords": "Struct ClientInfo Inherited Members System.ValueType.Equals(System.Object) System.ValueType.GetHashCode() System.ValueType.ToString() System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetType() Namespace : Octo_Client Assembly : Octo-Client.dll Syntax public struct ClientInfo Fields | Improve this Doc View Source octoAuth Declaration public NetworkStream<IOctoAuth> octoAuth Field Value Type Description NetworkStream < IOctoAuth > | Improve this Doc View Source octoProjects Declaration public NetworkStream<IOctoProjects> octoProjects Field Value Type Description NetworkStream < IOctoProjects > | Improve this Doc View Source octoService Declaration public NetworkStream<IOctoService> octoService Field Value Type Description NetworkStream < IOctoService > | Improve this Doc View Source UserToken Declaration public byte[] UserToken Field Value Type Description System.Byte []"
  },
  "api-core/Octo.html": {
    "href": "api-core/Octo.html",
    "title": "Namespace Octo | Octo - Documentation",
    "keywords": "Namespace Octo Classes CollectionDiff Class that describes the difference between two collections, with utility methods. Config Config parsing class, which takes in a standard \"INI\"-style format. DiffGenerator Class to generate a diff between two folders. Can also apply diffs. DirectoryCollection A tree class of files and file names. Contains a root node \"Directory\". DirectoryNode A single node which may comprise a tree. Contains children and a reference to the parent object. FolderZipManager A wrapper class which allows the creation and usage of GZipped streams in memory. Manifest Class to process and generate diff manifests. Project Parent class for all version control instances in Octo. Holds everything pertaining to a specific instance of version control (issues, chat, repository) as well as an ID and name. Repository Holds all files and change data for the project, as well as signing keys. Anything that is uploaded or downloaded directly from the server is held here. Utils Utility class for miscellaneous useful commands, such as printing to console in colour, checking files are equal. ValuePair<T1, T2> DataContract and Public version of the KeyValuePair integral class in C#. Built for transferring data on WCF. Vault Public class which holds reverse deltas for the project. Structs ProjectPermissions Struct to describe which users have what permissions. PullWrapper Wrapper for pull information to comply with WCF's \"one in-one out\" policy. PushWrapper Wrapper for push information to comply with WCF's \"one in-one out\" policy. Interfaces IOctoAuth Octo Authorization interface for logging in, logging out, and verifying users. IOctoProjects Project interface for clients attempting to manage repos. IOctoService The public interface outline for basic Octo functions, with function prototypes. IOctoStorage Enums UserPermissions DataContract serializable permissions enum."
  },
  "api-server/Octo_Server.Serialize.html": {
    "href": "api-server/Octo_Server.Serialize.html",
    "title": "Class Serialize | Octo - Documentation",
    "keywords": "Class Serialize Inheritance System.Object Serialize Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public static class Serialize Methods | Improve this Doc View Source FromJSON<T>(String) Declaration public static T FromJSON<T>(string filePath) where T : new() Parameters Type Name Description System.String filePath Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source ToJSON<T>(String, T, Boolean) Declaration public static void ToJSON<T>(string filePath, T objectToWrite, bool append = false) where T : new() Parameters Type Name Description System.String filePath T objectToWrite System.Boolean append Type Parameters Name Description T"
  },
  "api-core/Octo.IOctoStorage.html": {
    "href": "api-core/Octo.IOctoStorage.html",
    "title": "Interface IOctoStorage | Octo - Documentation",
    "keywords": "Interface IOctoStorage Namespace : Octo Assembly : Octo-Core.dll Syntax [ServiceContract] public interface IOctoStorage Methods | Improve this Doc View Source Pull(PullWrapper) Pull changes for a given repository since last commit to local. Declaration [OperationContract] [WebInvoke(UriTemplate = \"/Pull\", BodyStyle = WebMessageBodyStyle.Wrapped)] byte[] Pull(PullWrapper p) Parameters Type Name Description PullWrapper p The \"PullWrapper\", as to adhere to a single input/output field in WCF. Returns Type Description System.Byte [] A file stream containing the commmits required. | Improve this Doc View Source Push(PushWrapper) Pushes the changes for a given repository since last commit to the server. Declaration [OperationContract] [WebInvoke(UriTemplate = \"/Push\", BodyStyle = WebMessageBodyStyle.Wrapped)] bool Push(PushWrapper p) Parameters Type Name Description PushWrapper p The \"PushWrapper\", as to adhere to a single input/output field in WCF. See \"PushWrapper\" for more details. Returns Type Description System.Boolean | Improve this Doc View Source RollBack(String, Byte[]) Reverts an existing commit, given the client has access. Declaration [OperationContract] [WebInvoke(BodyStyle = WebMessageBodyStyle.Wrapped)] bool RollBack(string repo, byte[] token_encrypted) Parameters Type Name Description System.String repo The repository to roll back. System.Byte [] token_encrypted The user's token, encrypted using the session key. Returns Type Description System.Boolean"
  },
  "api-core/Octo.IOctoAuth.html": {
    "href": "api-core/Octo.IOctoAuth.html",
    "title": "Interface IOctoAuth | Octo - Documentation",
    "keywords": "Interface IOctoAuth Octo Authorization interface for logging in, logging out, and verifying users. Namespace : Octo Assembly : Octo-Core.dll Syntax [ServiceContract] public interface IOctoAuth Methods | Improve this Doc View Source Login(String, LockedBytes, Key) Function to log the user into the server. Defined server-side. Declaration [OperationContract] [WebInvoke(BodyStyle = WebMessageBodyStyle.Wrapped)] KeyValuePair<bool, byte[]> Login(string user, LockedBytes signed_pass, Key client_pub) Parameters Type Name Description System.String user The username of the user. LockedBytes signed_pass The password of the user, encrypted using session key. Key client_pub The public key of the client. Returns Type Description System.Collections.Generic.KeyValuePair < System.Boolean , System.Byte []> A success/fail bool, and the client token (encrypted). | Improve this Doc View Source LogOut(Byte[]) Logs the user out from the server, provided they were logged in. Defined server-side. Declaration [OperationContract] [WebInvoke(BodyStyle = WebMessageBodyStyle.Wrapped)] bool LogOut(byte[] token) Parameters Type Name Description System.Byte [] token The token of the user, encrypted with the session key. Returns Type Description System.Boolean | Improve this Doc View Source Register(String, LockedBytes) Function to register the user for an account on the server. Defined server-side. Declaration [OperationContract] [WebInvoke(BodyStyle = WebMessageBodyStyle.Wrapped)] string Register(string user, LockedBytes signed_pass) Parameters Type Name Description System.String user The username of the user. LockedBytes signed_pass The password of the user, encrypted using session key. Returns Type Description System.String Success/failure message."
  },
  "api-client/Octo_Client.html": {
    "href": "api-client/Octo_Client.html",
    "title": "Namespace Octo_Client | Octo - Documentation",
    "keywords": "Namespace Octo_Client Classes NetworkStream<T> OctoClient Storage A class to middleman between the OctoClient class and the server for GZip streams. Structs ClientInfo"
  },
  "api-server/Octo_Server.OctoService.html": {
    "href": "api-server/Octo_Server.OctoService.html",
    "title": "Class OctoService | Octo - Documentation",
    "keywords": "Class OctoService Inheritance System.Object OctoService Implements IOctoService Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public class OctoService : IOctoService Methods | Improve this Doc View Source ACK() Declaration public string ACK() Returns Type Description System.String | Improve this Doc View Source GetSessionKey() Declaration public Key GetSessionKey() Returns Type Description Key Implements IOctoService"
  },
  "api-core/Octo.DiffGenerator.html": {
    "href": "api-core/Octo.DiffGenerator.html",
    "title": "Class DiffGenerator | Octo - Documentation",
    "keywords": "Class DiffGenerator Class to generate a diff between two folders. Can also apply diffs. Inheritance System.Object DiffGenerator Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class DiffGenerator Methods | Improve this Doc View Source ApplyDiffMatchPatch(String, String) Applies a generated DiffMatchPatch to the folder given. Declaration public static void ApplyDiffMatchPatch(string loc, string backuploc) Parameters Type Name Description System.String loc System.String backuploc | Improve this Doc View Source CreateDiffMatchPatch(String, String, String, CollectionDiff) Generates a DiffMatchPatch with manifest at the given location. Declaration public static void CreateDiffMatchPatch(string newloc, string oldloc, string backuploc, CollectionDiff diff) Parameters Type Name Description System.String newloc System.String oldloc System.String backuploc CollectionDiff diff"
  },
  "api-core/Octo.Config.html": {
    "href": "api-core/Octo.Config.html",
    "title": "Class Config | Octo - Documentation",
    "keywords": "Class Config Config parsing class, which takes in a standard \"INI\"-style format. Inheritance System.Object Config Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class Config Methods | Improve this Doc View Source ParseConfigFromFile(String) Wrapper for ParseConfigRaw() which takes in a file location instead of a raw string. Declaration public static Dictionary<string, string> ParseConfigFromFile(string loc) Parameters Type Name Description System.String loc The location of the UTF-8 config file. Returns Type Description System.Collections.Generic.Dictionary < System.String , System.String > A dictionary of parameters and their values. | Improve this Doc View Source ParseRawConfig(String) A simple method for parsing a standard .cfg configuration file. Declaration public static Dictionary<string, string> ParseRawConfig(string s) Parameters Type Name Description System.String s The raw config file, as a string. Returns Type Description System.Collections.Generic.Dictionary < System.String , System.String > A map of parameters and values."
  },
  "api-server/Octo_Server.OctoStorage.html": {
    "href": "api-server/Octo_Server.OctoStorage.html",
    "title": "Class OctoStorage | Octo - Documentation",
    "keywords": "Class OctoStorage Inheritance System.Object OctoStorage Implements IOctoStorage Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public class OctoStorage : IOctoStorage Constructors | Improve this Doc View Source OctoStorage() Declaration public OctoStorage() Methods | Improve this Doc View Source CheckUserAndProject(Byte[], String, UserPermissions) Checks whether the given user exists, whether the project exists, and whether the user has permissions. Declaration public bool CheckUserAndProject(byte[] token_encrypted, string repoName, UserPermissions requiredPermLevel) Parameters Type Name Description System.Byte [] token_encrypted The user token. System.String repoName The repository name to check. UserPermissions requiredPermLevel The required permission level to return true. Returns Type Description System.Boolean True/false. | Improve this Doc View Source Pull(PullWrapper) Pulls the given repository from the server, given permissions. Declaration public byte[] Pull(PullWrapper p) Parameters Type Name Description PullWrapper p Returns Type Description System.Byte [] MemoryStream of the GZipped project. | Improve this Doc View Source Push(PushWrapper) Declaration public bool Push(PushWrapper p) Parameters Type Name Description PushWrapper p Returns Type Description System.Boolean | Improve this Doc View Source RollBack(String, Byte[]) Rolls back the given repository to the last commit. Declaration public bool RollBack(string repo, byte[] token_encrypted) Parameters Type Name Description System.String repo The repository to roll back. System.Byte [] token_encrypted The user's encrypted token. Returns Type Description System.Boolean Implements IOctoStorage"
  },
  "api-core/Octo.FolderZipManager.html": {
    "href": "api-core/Octo.FolderZipManager.html",
    "title": "Class FolderZipManager | Octo - Documentation",
    "keywords": "Class FolderZipManager A wrapper class which allows the creation and usage of GZipped streams in memory. Inheritance System.Object FolderZipManager Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class FolderZipManager Constructors | Improve this Doc View Source FolderZipManager(String, String) Constructor to automatically zip a folder. Declaration public FolderZipManager(string folder, string zipFullPath) Parameters Type Name Description System.String folder The folder to zip. System.String zipFullPath The desired temporary storage location. Methods | Improve this Doc View Source GetWrapper() Returns a stream of the original folder. Declaration public byte[] GetWrapper() Returns Type Description System.Byte [] Folder stream (MemStream) | Improve this Doc View Source SaveFolderFromWrapper(Byte[], String, String, Boolean) Saves a folder from a given stream that has been processed by FZM. Ensure that ZipExtractPath is NOT within folderPath. Declaration public static void SaveFolderFromWrapper(byte[] b, string zipExtractPath, string folderPath, bool deleteAfter = true) Parameters Type Name Description System.Byte [] b The raw bytes of the wrapper. System.String zipExtractPath The path to extract the zip to. System.String folderPath System.Boolean deleteAfter"
  },
  "api-core/Octo.PullWrapper.html": {
    "href": "api-core/Octo.PullWrapper.html",
    "title": "Struct PullWrapper | Octo - Documentation",
    "keywords": "Struct PullWrapper Wrapper for pull information to comply with WCF's \"one in-one out\" policy. Inherited Members System.ValueType.Equals(System.Object) System.ValueType.GetHashCode() System.ValueType.ToString() System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetType() Namespace : Octo Assembly : Octo-Core.dll Syntax [MessageContract] public struct PullWrapper Fields | Improve this Doc View Source repo The repository to pull from the server. Declaration [MessageBodyMember] public string repo Field Value Type Description System.String | Improve this Doc View Source token_encrypted The user's encrypted token. Declaration [MessageBodyMember] public byte[] token_encrypted Field Value Type Description System.Byte []"
  },
  "api-core/Octo.Manifest.html": {
    "href": "api-core/Octo.Manifest.html",
    "title": "Class Manifest | Octo - Documentation",
    "keywords": "Class Manifest Class to process and generate diff manifests. Inheritance System.Object Manifest Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class Manifest Methods | Improve this Doc View Source Parse(String) Parse a manifest file (as string) into a valid CollectionDiff. Declaration public static CollectionDiff Parse(string manstring) Parameters Type Name Description System.String manstring The manifest file (as a string). Returns Type Description CollectionDiff CollectionDiff of the original manifest."
  },
  "api-server/Octo_Server.html": {
    "href": "api-server/Octo_Server.html",
    "title": "Namespace Octo_Server | Octo - Documentation",
    "keywords": "Namespace Octo_Server Classes Constants Error A public class to handle any error-based interaction in Octo. OctoProjects OctoService OctoStorage Permissions Serialize Server Structs User Basic user struct containing username, password."
  },
  "api-server/Octo_Server.Error.html": {
    "href": "api-server/Octo_Server.Error.html",
    "title": "Class Error | Octo - Documentation",
    "keywords": "Class Error A public class to handle any error-based interaction in Octo. Inheritance System.Object Error Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public class Error Methods | Improve this Doc View Source Print(String) Declaration public static void Print(string e) Parameters Type Name Description System.String e"
  },
  "api-core/Octo.ValuePair-2.html": {
    "href": "api-core/Octo.ValuePair-2.html",
    "title": "Class ValuePair<T1, T2> | Octo - Documentation",
    "keywords": "Class ValuePair<T1, T2> DataContract and Public version of the KeyValuePair integral class in C#. Built for transferring data on WCF. Inheritance System.Object ValuePair<T1, T2> Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax [DataContract] public class ValuePair<T1, T2> Type Parameters Name Description T1 A serializable type. T2 A serializable type. Constructors | Improve this Doc View Source ValuePair(T1, T2) Declaration public ValuePair(T1 Key_, T2 Value_) Parameters Type Name Description T1 Key_ T2 Value_ Fields | Improve this Doc View Source Key Declaration [DataMember] public T1 Key Field Value Type Description T1 | Improve this Doc View Source Value Declaration [DataMember] public T2 Value Field Value Type Description T2"
  },
  "api-core/Octo.DirectoryCollection.html": {
    "href": "api-core/Octo.DirectoryCollection.html",
    "title": "Class DirectoryCollection | Octo - Documentation",
    "keywords": "Class DirectoryCollection A tree class of files and file names. Contains a root node \"Directory\". Inheritance System.Object DirectoryCollection Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class DirectoryCollection Constructors | Improve this Doc View Source DirectoryCollection() Initializes a node with no files. Declaration public DirectoryCollection() | Improve this Doc View Source DirectoryCollection(DirectoryNode, String) Initializes a node with a given root node, and a spoofed location. Declaration public DirectoryCollection(DirectoryNode Root_, string spoofedLoc) Parameters Type Name Description DirectoryNode Root_ System.String spoofedLoc | Improve this Doc View Source DirectoryCollection(String) Initialize node recursively at location. Declaration public DirectoryCollection(string loc) Parameters Type Name Description System.String loc | Improve this Doc View Source DirectoryCollection(String, String) Initialize node recursively at location, with custom root. Declaration public DirectoryCollection(string loc, string root) Parameters Type Name Description System.String loc System.String root Fields | Improve this Doc View Source Root The root node in the collection. Declaration public DirectoryNode Root Field Value Type Description DirectoryNode | Improve this Doc View Source RootPath Declaration public string RootPath Field Value Type Description System.String Methods | Improve this Doc View Source MergeCollections(DirectoryNode, DirectoryNode, DirectoryNode) Merges two DirectoryCollections into one. Declaration public static DirectoryNode MergeCollections(DirectoryNode old, DirectoryNode new_, DirectoryNode parentNode = null) Parameters Type Name Description DirectoryNode old Old directory collection. DirectoryNode new_ New directory collectoin. DirectoryNode parentNode Returns Type Description DirectoryNode A merged set in a DirNode."
  },
  "api-client/Octo_Client.NetworkStream-1.html": {
    "href": "api-client/Octo_Client.NetworkStream-1.html",
    "title": "Class NetworkStream<T> | Octo - Documentation",
    "keywords": "Class NetworkStream<T> Inheritance System.Object NetworkStream<T> Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Client Assembly : Octo-Client.dll Syntax public class NetworkStream<T> Type Parameters Name Description T Constructors | Improve this Doc View Source NetworkStream(String) Declaration public NetworkStream(string uri) Parameters Type Name Description System.String uri Fields | Improve this Doc View Source channel Declaration public T channel Field Value Type Description T"
  },
  "api-core/Octo.IOctoProjects.html": {
    "href": "api-core/Octo.IOctoProjects.html",
    "title": "Interface IOctoProjects | Octo - Documentation",
    "keywords": "Interface IOctoProjects Project interface for clients attempting to manage repos. Namespace : Octo Assembly : Octo-Core.dll Syntax [ServiceContract] public interface IOctoProjects Methods | Improve this Doc View Source CreateProject(String, Byte[]) Creates a project on the server given a name and token. Declaration [OperationContract] [WebInvoke(BodyStyle = WebMessageBodyStyle.Wrapped)] bool CreateProject(string name, byte[] token_encrypted) Parameters Type Name Description System.String name The name of the project to create. System.Byte [] token_encrypted The user's token encrypted with a session key. Returns Type Description System.Boolean Success of creation. | Improve this Doc View Source DeleteProject(String, Byte[]) Declaration [OperationContract] [WebInvoke(BodyStyle = WebMessageBodyStyle.Wrapped)] bool DeleteProject(string project, byte[] token_encrypted) Parameters Type Name Description System.String project System.Byte [] token_encrypted Returns Type Description System.Boolean | Improve this Doc View Source GetAvailableProjects(Byte[]) Declaration [OperationContract] [WebInvoke(BodyStyle = WebMessageBodyStyle.Wrapped)] ValuePair<bool, List<Project>> GetAvailableProjects(byte[] token_encrypted) Parameters Type Name Description System.Byte [] token_encrypted Returns Type Description ValuePair < System.Boolean , System.Collections.Generic.List < Project >> | Improve this Doc View Source SetUserPermissions(String, String, UserPermissions, Byte[]) Sets a user's permission level on a given project. Declaration [OperationContract] [WebInvoke(BodyStyle = WebMessageBodyStyle.Wrapped)] bool SetUserPermissions(string project, string user, UserPermissions perms, byte[] token_encrypted) Parameters Type Name Description System.String project The name of the repo to set permissions on. System.String user The user to set permissions for. UserPermissions perms The permission level of the user. System.Byte [] token_encrypted The token of the user, encrypted with the session key. Returns Type Description System.Boolean"
  },
  "api-core/Octo.Utils.html": {
    "href": "api-core/Octo.Utils.html",
    "title": "Class Utils | Octo - Documentation",
    "keywords": "Class Utils Utility class for miscellaneous useful commands, such as printing to console in colour, checking files are equal. Inheritance System.Object Utils Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class Utils Methods | Improve this Doc View Source CopyAll(DirectoryInfo, DirectoryInfo) Wrapper for CopyDirectory, taking DirInfos instead of locations. Declaration public static void CopyAll(DirectoryInfo source, DirectoryInfo target) Parameters Type Name Description System.IO.DirectoryInfo source System.IO.DirectoryInfo target | Improve this Doc View Source CopyDirectory(String, String) Copies an entire directory (including contents) from one place to another, recursively. Declaration public static void CopyDirectory(string sourceDirectory, string targetDirectory) Parameters Type Name Description System.String sourceDirectory System.String targetDirectory | Improve this Doc View Source FilesAreEqual(FileInfo, FileInfo) Checks a set amount of random bits in the file to see if they are equal. Declaration public static bool FilesAreEqual(FileInfo first, FileInfo second) Parameters Type Name Description System.IO.FileInfo first First file. System.IO.FileInfo second Second file. Returns Type Description System.Boolean | Improve this Doc View Source RawByteString(Byte[]) Prints the raw byte representation of a byte array. Declaration public static string RawByteString(byte[] bytes) Parameters Type Name Description System.Byte [] bytes Bytes to print. Returns Type Description System.String | Improve this Doc View Source WipeDirectory(String) Declaration public static void WipeDirectory(string dir) Parameters Type Name Description System.String dir | Improve this Doc View Source WriteLineColour(String, ConsoleColor) Writes the given string in a console colour. Declaration public static void WriteLineColour(string toWrite, ConsoleColor c) Parameters Type Name Description System.String toWrite System.ConsoleColor c"
  },
  "api-core/Octo.PushWrapper.html": {
    "href": "api-core/Octo.PushWrapper.html",
    "title": "Struct PushWrapper | Octo - Documentation",
    "keywords": "Struct PushWrapper Wrapper for push information to comply with WCF's \"one in-one out\" policy. Inherited Members System.ValueType.Equals(System.Object) System.ValueType.GetHashCode() System.ValueType.ToString() System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetType() Namespace : Octo Assembly : Octo-Core.dll Syntax [MessageContract] public struct PushWrapper Fields | Improve this Doc View Source file The streamed file (in bytes) to transfer to the server. Declaration [MessageBodyMember] public byte[] file Field Value Type Description System.Byte [] | Improve this Doc View Source repo The repository to pull from the server. Declaration [MessageBodyMember] public string repo Field Value Type Description System.String | Improve this Doc View Source token_encrypted The user's encrypted token. Declaration [MessageBodyMember] public byte[] token_encrypted Field Value Type Description System.Byte []"
  },
  "api-server/Octo_Server.Permissions.html": {
    "href": "api-server/Octo_Server.Permissions.html",
    "title": "Class Permissions | Octo - Documentation",
    "keywords": "Class Permissions Inheritance System.Object Permissions Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public class Permissions"
  },
  "api-server/Octo_Server.OctoProjects.html": {
    "href": "api-server/Octo_Server.OctoProjects.html",
    "title": "Class OctoProjects | Octo - Documentation",
    "keywords": "Class OctoProjects Inheritance System.Object OctoProjects Implements IOctoProjects Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public class OctoProjects : IOctoProjects Constructors | Improve this Doc View Source OctoProjects() The OctoProjects implementation. For more base information, see the OctoCore docs on IOctoProjects. Declaration public OctoProjects() Fields | Improve this Doc View Source ProjectDBLocation Declaration public string ProjectDBLocation Field Value Type Description System.String | Improve this Doc View Source Projects Declaration public static List<Project> Projects Field Value Type Description System.Collections.Generic.List < Project > Methods | Improve this Doc View Source CreateProject(String, Byte[]) Declaration public bool CreateProject(string name, byte[] token_encrypted) Parameters Type Name Description System.String name System.Byte [] token_encrypted Returns Type Description System.Boolean | Improve this Doc View Source DeleteProject(String, Byte[]) Removes a project from the server, when given a name and valid token. Declaration public bool DeleteProject(string project, byte[] token_encrypted) Parameters Type Name Description System.String project The project to delete. System.Byte [] token_encrypted Valid user token. Returns Type Description System.Boolean Success/failure. | Improve this Doc View Source GetAvailableProjects(Byte[]) Gets all projects available to the connecting user. Declaration public ValuePair<bool, List<Project>> GetAvailableProjects(byte[] token_encrypted) Parameters Type Name Description System.Byte [] token_encrypted The user's encrypted token. Returns Type Description ValuePair < System.Boolean , System.Collections.Generic.List < Project >> A list of available projects. | Improve this Doc View Source LoadProjectDB() Declaration public void LoadProjectDB() | Improve this Doc View Source ProjectExists(String) Checks if a given project exists in the project database. Declaration public static bool ProjectExists(string name) Parameters Type Name Description System.String name The name of the project. Returns Type Description System.Boolean Exists/does not. | Improve this Doc View Source SaveProjectDB() Declaration public void SaveProjectDB() | Improve this Doc View Source SetUserPermissions(String, String, UserPermissions, Byte[]) Sets a user's permissions for a project, given the attempting user has full permissions. Declaration public bool SetUserPermissions(string project, string user, UserPermissions perms, byte[] token_encrypted) Parameters Type Name Description System.String project System.String user UserPermissions perms System.Byte [] token_encrypted Returns Type Description System.Boolean Implements IOctoProjects"
  },
  "api-core/Octo.ProjectPermissions.html": {
    "href": "api-core/Octo.ProjectPermissions.html",
    "title": "Struct ProjectPermissions | Octo - Documentation",
    "keywords": "Struct ProjectPermissions Struct to describe which users have what permissions. Inherited Members System.ValueType.Equals(System.Object) System.ValueType.GetHashCode() System.ValueType.ToString() System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetType() Namespace : Octo Assembly : Octo-Core.dll Syntax [DataContract] public struct ProjectPermissions Fields | Improve this Doc View Source PermissionLevel Declaration [DataMember] public UserPermissions PermissionLevel Field Value Type Description UserPermissions | Improve this Doc View Source User Declaration [DataMember] public string User Field Value Type Description System.String"
  },
  "articles/serverconfigflags.html": {
    "href": "articles/serverconfigflags.html",
    "title": "Configuration Options | Octo - Documentation",
    "keywords": "Configuration Options For the server portion of Octo, you must have a configuration file \"_config.octo\" stored in the executing directory. Here is the full list of configuration options for that file, along with an example file below to show how they should be structured. These are left as the default value unless overwritten explicitly in the config file. Parameter Name Type Default Value server_ip string 127.0.0.1 server_port int 13000 project_location string Executing Location + \"\\projects\\\" streaming_location string Executing Location + \"\\streaming\\\" users_location string Executing Location + \"\\users\\\" Example Config File: server_ip=234.257.1.43 server_port=12930 project_location=D:\\MyProjectLocation\\ streaming_location=D:\\MyStreamingLocation\\ users_location=D:\\myUsersLoc\\"
  },
  "articles/index.html": {
    "href": "articles/index.html",
    "title": "Welcome to the example boring page! | Octo - Documentation",
    "keywords": "Welcome to the example boring page!"
  },
  "api/index.html": {
    "href": "api/index.html",
    "title": "PLACEHOLDER | Octo - Documentation",
    "keywords": "PLACEHOLDER TODO: Add .NET projects to src folder and run docfx to generate a REAL API Documentation !"
  },
  "index.html": {
    "href": "index.html",
    "title": "Welcome to the Octo Documentation. | Octo - Documentation",
    "keywords": "Welcome to the Octo Documentation. To learn how to quickly start up an Octo project, please refer to the Quick Start Guide . Or, follow the steps below. Quick Start Configuring the Server First, you must create a new text file in the server directory named \"_config.octo\". Then, in this file, you can specify the properties you wish to use, if they are different from the default values. You can read about the default values and config properties in Octo here. Here is an extremely simple example config file. Note: A config file must exist for the server to run, even if it is blank. server_ip=127.0.0.1 server_port=13000 Once you have created this config file, you can then start the server. When starting it up for the first time, please change the default user account from \"admin\". Further configuration of individual projects is all done client-side. Logging in with the default user will allow you to change most of these settings. Using the GUI Client The GUI client currently does not exist. Using the Client API The client API is made up of three main components: The Project Manager (octoProjectManager) The Authentication Service (octoAuthService) The Client Hook When attempting to connect to a server, use the authentication service to connect to the address, like in the example below. var myClient = new OctoClient(\"myepicwebsite.com\", 6920); bool success = myClient.Login(\"Jimmy_Neutron\", \"jimmyneutron123\"); You can then use the Project Manager to create and destroy projects, push and pull projects, and add or change permission for users. This is done like so: //Create a project. myClient.CreateProject(\"ProjectName\"); //Set user permissions for a project. myClient.SetUserPermissions(\"ProjectName\", \"someUser\", UserPermissions.FULL_PERMISSION); //Delete a project. myClient.DeleteProject(\"ProjectName\"); You can also access the user's raw token (if required for some purpose) by using myClient.GetEncryptedToken() . For more information on how to use Octo, please check the \"Guides\" section in the navigation bar."
  },
  "articles/apilayout.html": {
    "href": "articles/apilayout.html",
    "title": "API Structure | Octo - Documentation",
    "keywords": "API Structure The API in Octo is a heirarchy of inheritance from Core down to Server and Client, and so on. Here is a simple diagram to give an idea of how the project is structured."
  },
  "api-client/Octo_Client.Storage.html": {
    "href": "api-client/Octo_Client.Storage.html",
    "title": "Class Storage | Octo - Documentation",
    "keywords": "Class Storage A class to middleman between the OctoClient class and the server for GZip streams. Inheritance System.Object Storage Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Client Assembly : Octo-Client.dll Syntax public class Storage Constructors | Improve this Doc View Source Storage(Byte[], NetworkStream<IOctoStorage>) Basic constructor to set stream and token for use later. Declaration public Storage(byte[] token_encrypted_, NetworkStream<IOctoStorage> octoStorage_) Parameters Type Name Description System.Byte [] token_encrypted_ Valid user token (encrypted) NetworkStream < IOctoStorage > octoStorage_ An OctoStorage network stream. Methods | Improve this Doc View Source Pull(String, String, String) Declaration public bool Pull(string repo, string saveLoc, string tempLoc) Parameters Type Name Description System.String repo System.String saveLoc System.String tempLoc Returns Type Description System.Boolean | Improve this Doc View Source Push(String, String, String) Declaration public bool Push(string repo, string fromLoc, string tempLoc) Parameters Type Name Description System.String repo System.String fromLoc System.String tempLoc Returns Type Description System.Boolean"
  },
  "api-client/Octo_Client.OctoClient.html": {
    "href": "api-client/Octo_Client.OctoClient.html",
    "title": "Class OctoClient | Octo - Documentation",
    "keywords": "Class OctoClient Inheritance System.Object OctoClient Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Client Assembly : Octo-Client.dll Syntax public class OctoClient Constructors | Improve this Doc View Source OctoClient(String, Int32) Declaration public OctoClient(string address, int port) Parameters Type Name Description System.String address System.Int32 port Fields | Improve this Doc View Source ClientKeys Declaration public KeyPair ClientKeys Field Value Type Description KeyPair | Improve this Doc View Source octoAuth Declaration public NetworkStream<IOctoAuth> octoAuth Field Value Type Description NetworkStream < IOctoAuth > | Improve this Doc View Source octoProjects Declaration public NetworkStream<IOctoProjects> octoProjects Field Value Type Description NetworkStream < IOctoProjects > | Improve this Doc View Source octoService Declaration public NetworkStream<IOctoService> octoService Field Value Type Description NetworkStream < IOctoService > | Improve this Doc View Source octoStorage Declaration public NetworkStream<IOctoStorage> octoStorage Field Value Type Description NetworkStream < IOctoStorage > | Improve this Doc View Source ServerAddress Declaration public string ServerAddress Field Value Type Description System.String | Improve this Doc View Source SessionKey Declaration public Key SessionKey Field Value Type Description Key Methods | Improve this Doc View Source CreateProject(String, String) Creates a project server-side with a given name. Declaration public bool CreateProject(string project, string fileLocation) Parameters Type Name Description System.String project The name of the project. System.String fileLocation Returns Type Description System.Boolean Success/failure. | Improve this Doc View Source DeleteProject(String) Deletes a project server-side with a given name. Declaration public bool DeleteProject(string project) Parameters Type Name Description System.String project The name of the project. Returns Type Description System.Boolean Success/failure. | Improve this Doc View Source GetAvailableProjects() Gets the projects available to the logged-in user. Declaration public ValuePair<bool, List<Project>> GetAvailableProjects() Returns Type Description ValuePair < System.Boolean , System.Collections.Generic.List < Project >> Success/fail, list of projects. | Improve this Doc View Source GetEncryptedToken() Returns a token encrypted with the server session key. Declaration public byte[] GetEncryptedToken() Returns Type Description System.Byte [] | Improve this Doc View Source Login(String, String) Logs the user into the server with a given username and password. Declaration public bool Login(string username, string password) Parameters Type Name Description System.String username System.String password Returns Type Description System.Boolean | Improve this Doc View Source LogOut() Logs the current client user out from the server. Declaration public bool LogOut() Returns Type Description System.Boolean Sucessful/Unsuccessful | Improve this Doc View Source PullRepo(String, String) Declaration public bool PullRepo(string repo, string repoLocation) Parameters Type Name Description System.String repo System.String repoLocation Returns Type Description System.Boolean | Improve this Doc View Source PushRepo(String, String) Declaration public bool PushRepo(string repo, string repoLocation) Parameters Type Name Description System.String repo System.String repoLocation Returns Type Description System.Boolean | Improve this Doc View Source Register(String, String) Registers a new user, from the active client. Declaration public string Register(string username, string password) Parameters Type Name Description System.String username The username to register. System.String password The password to register. Returns Type Description System.String | Improve this Doc View Source SetProjectPermissions(String, String, UserPermissions) Sets the permissions for a given user on a given project. Declaration public bool SetProjectPermissions(string project, string user, UserPermissions permissions) Parameters Type Name Description System.String project The project to set permissions for. System.String user The user to set permissions for. UserPermissions permissions The permission level to give them. Returns Type Description System.Boolean Success/failure."
  },
  "api-core/Octo.UserPermissions.html": {
    "href": "api-core/Octo.UserPermissions.html",
    "title": "Enum UserPermissions | Octo - Documentation",
    "keywords": "Enum UserPermissions DataContract serializable permissions enum. Namespace : Octo Assembly : Octo-Core.dll Syntax [DataContract] [Flags] public enum UserPermissions Fields Name Description FULL_PERMISSIONS NOPERMS READ_PERMISSIONS WRITEREAD_PERMISSIONS"
  },
  "api-server/Octo_Server.Constants.html": {
    "href": "api-server/Octo_Server.Constants.html",
    "title": "Class Constants | Octo - Documentation",
    "keywords": "Class Constants Inheritance System.Object Constants Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo_Server Assembly : Octo-Server.dll Syntax public static class Constants Fields | Improve this Doc View Source ProjectsLocation Declaration public static string ProjectsLocation Field Value Type Description System.String | Improve this Doc View Source ServerLocation Declaration public static string ServerLocation Field Value Type Description System.String | Improve this Doc View Source StreamLocation Declaration public static string StreamLocation Field Value Type Description System.String | Improve this Doc View Source UsersLocation Declaration public static string UsersLocation Field Value Type Description System.String"
  },
  "api-core/Octo.Vault.html": {
    "href": "api-core/Octo.Vault.html",
    "title": "Class Vault | Octo - Documentation",
    "keywords": "Class Vault Public class which holds reverse deltas for the project. Inheritance System.Object Vault Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax public class Vault Constructors | Improve this Doc View Source Vault(String) Basic vault constructor taking a file location. Declaration public Vault(string vaultLocation) Parameters Type Name Description System.String vaultLocation Fields | Improve this Doc View Source CurrentVersion Declaration public ulong CurrentVersion Field Value Type Description System.UInt64 | Improve this Doc View Source Location Declaration public string Location Field Value Type Description System.String Methods | Improve this Doc View Source CreateBackup(String) Creates a backup of the current DirectoryCollection. Declaration public void CreateBackup(string loc) Parameters Type Name Description System.String loc | Improve this Doc View Source RollBack(String) Rolls back the current version of the repository by one commit. Declaration public bool RollBack(string loc) Parameters Type Name Description System.String loc Returns Type Description System.Boolean"
  },
  "api-core/Octo.Project.html": {
    "href": "api-core/Octo.Project.html",
    "title": "Class Project | Octo - Documentation",
    "keywords": "Class Project Parent class for all version control instances in Octo. Holds everything pertaining to a specific instance of version control (issues, chat, repository) as well as an ID and name. Inheritance System.Object Project Inherited Members System.Object.ToString() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.ReferenceEquals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() Namespace : Octo Assembly : Octo-Core.dll Syntax [DataContract] public class Project Constructors | Improve this Doc View Source Project(String, String) Basic constructor for a project, setting name and location. Declaration public Project(string Name_, string Location_) Parameters Type Name Description System.String Name_ Name of the repo (should be synced with server). System.String Location_ File location (relative) of the repo on the machine. Fields | Improve this Doc View Source Location Declaration [DataMember] public string Location Field Value Type Description System.String | Improve this Doc View Source Name Declaration [DataMember] public string Name Field Value Type Description System.String | Improve this Doc View Source Permissions Declaration [DataMember] public List<ProjectPermissions> Permissions Field Value Type Description System.Collections.Generic.List < ProjectPermissions > Methods | Improve this Doc View Source RollBack() Rolls back the repository to the previous version. Declaration public bool RollBack() Returns Type Description System.Boolean | Improve this Doc View Source UserHasPermissions(String, UserPermissions) Checks whether a given user has the permission level specified for this project. Declaration public bool UserHasPermissions(string user, UserPermissions level) Parameters Type Name Description System.String user The username of the user to check. UserPermissions level The level the user must have to return true. Returns Type Description System.Boolean True/false does have permissions."
  },
  "api-core/Octo.IOctoService.html": {
    "href": "api-core/Octo.IOctoService.html",
    "title": "Interface IOctoService | Octo - Documentation",
    "keywords": "Interface IOctoService The public interface outline for basic Octo functions, with function prototypes. Namespace : Octo Assembly : Octo-Core.dll Syntax [ServiceContract] public interface IOctoService Methods | Improve this Doc View Source ACK() Asks the server for acknowledgement of a connection. Declaration [OperationContract] [WebGet] string ACK() Returns Type Description System.String String response of acknowledgement or rejection. | Improve this Doc View Source GetSessionKey() Gets a session key for the user for encrypting sensitive data. Declaration [OperationContract] [WebGet] Key GetSessionKey() Returns Type Description Key A valid session key."
  }
}