Struct MSServiceAccount

Source

pub struct MSServiceAccount { /* private fields */ }

Available on crate feature MSServiceAccount only.

Expand description

Account details for accessing a streaming media service.

Implementations§

Source §

impl MSServiceAccount

Source

pub unsafe fn initWithServiceName_accountName( this: Allocated<Self>, service_name: &NSString, account_name: &NSString, ) -> Retained<Self>

Creates a new account.

Parameters:
serviceName: The name of the streaming media service.
accountName: The user’s display name in the streaming media service.

Source

pub unsafe fn serviceName(&self) -> Retained<NSString>

The localized name of the streaming media service.

Source

pub unsafe fn accountName(&self) -> Retained<NSString>

The user’s display name, email address, or other identifier in a streaming media service.

Source

pub unsafe fn clientID(&self) -> Option<Retained<NSString>>

A user identifier for the token request.

The Media Setup framework uses the MSServiceAccount/clientID to create a token request. You can choose the identifier format, but the identifier must be unique to the current account. You can provide a new identifier each time the user begins the home setup.

Source

pub unsafe fn setClientID(&self, client_id: Option<&NSString>)

Setter for clientID.

This is copied when set.

Source

pub unsafe fn clientSecret(&self) -> Option<Retained<NSString>>

A string that authenticates the user’s setup request.

The Media Setup framework uses the clientSecret to create a token request. Hashed passwords are acceptable, but plaintext passwords aren’t.

Source

pub unsafe fn setClientSecret(&self, client_secret: Option<&NSString>)

Setter for clientSecret.

This is copied when set.

Source

pub unsafe fn configurationURL(&self) -> Option<Retained<NSURL>>

The path to access the configuration endpoint of your streaming media service for the home.

The device retrieves the configuration with the OAuth 2.0 Bearer token.

Source

pub unsafe fn setConfigurationURL(&self, configuration_url: Option<&NSURL>)

Setter for configurationURL.

This is copied when set.

Source

pub unsafe fn authorizationTokenURL(&self) -> Option<Retained<NSURL>>

A URL that provides a token for the user’s HomePod speakers.

The authorization token URL is an OAuth 2.0 token service endpoint that provides a Bearer Token for retrieving configuration.

Source

pub unsafe fn setAuthorizationTokenURL( &self, authorization_token_url: Option<&NSURL>, )

Setter for authorizationTokenURL.

This is copied when set.

Source

pub unsafe fn authorizationScope(&self) -> Option<Retained<NSString>>

A list of permissions for the token request.

The authorization scope is an optional OAuth 2.0 scope parameter the system provides when requesting a token.

Source

pub unsafe fn setAuthorizationScope( &self, authorization_scope: Option<&NSString>, )

Setter for authorizationScope.

This is copied when set.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}