Version: Unity 6.1 (6000.1)
LanguageEnglish
  • C#

ProjectCapabilityManager.AddBackgroundModes

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void AddBackgroundModes(iOS.Xcode.BackgroundModesOptions options);

Parameters

Parameter Description
options Mask of BackgroundModesOptions to enable.

Description

Add the Background Modes capability.

using UnityEditor;
using UnityEditor.Callbacks;
using UnityEditor.iOS.Xcode;

public class Sample_AddBackgroundModes { [PostProcessBuild] public static void OnPostprocessBuild(BuildTarget buildTarget, string pathToBuiltProject) { // Stop processing if build target isn't iOS

if (buildTarget != BuildTarget.iOS) return;

// Initialize PBXProject var projectPath = PBXProject.GetPBXProjectPath(pathToBuiltProject); PBXProject pbxProject = new PBXProject(); pbxProject.ReadFromFile(projectPath);

// Get Main target GUID string mainTargetGuid = pbxProject.GetUnityMainTargetGuid();

// Check if there's already an entitlements file created and use it. If not, create a new file called Example.entitlements string entitlementsFile = pbxProject.GetBuildPropertyForAnyConfig(mainTargetGuid, "CODE_SIGN_ENTITLEMENTS"); if (entitlementsFile == null) { entitlementsFile = string.Format("Example.entitlements"); }

// Initialize ProjectCapabilityManager ProjectCapabilityManager capabilityManager = new ProjectCapabilityManager(projectPath, entitlementsFile, targetGuid: mainTargetGuid);

// Add 'Background Modes' capability and pass any BackgroundModes you want to enable capabilityManager.AddBackgroundModes(BackgroundModesOptions.BackgroundFetch | BackgroundModesOptions.LocationUpdates);

// Call WriteToFile to save the changes to project file capabilityManager.WriteToFile(); }

}