Documentation

The Marianapolis Athletics app is a free iOS app designed to bring everything related to our athletics program into one place. The app provides quick access to the content our fans are looking for and is always up-to-date on the most current information.

Supported Devices

• iPad 2 or later,
• iPhone 5 or later,
• iPod touch (5th generation) or later,
• Devices running iOS 9.1 or later

Standard Use

Download and Install

Initial Setup

When asked, allow push notifications to receive reminders of upcoming events and important announcements from the athletics department. Then take a short walkthrough of some of the major features the app offers. From there you will be presented with the MyAthlete setup pane where you can select your team and customize the information displayed in the app. You may choose to skip this step for now if you do not wish to select a team. At this point the app is ready to go.

This Season

The "This season" tab contains all of the top content from the current sports season. The section is divided into four parts: Events, Scores, Recaps, and Knight of the Week.

Events: The Events tab contains a list of upcoming events as well as the individual schedules for each of our teams. This information is pulled directly from our website so you can be sure that it's always up-to-date.

Scores: The Scores tab displays the MPrep Athletics Twitter timeline where score updates are typically posted.

Recaps: Event write-ups are posted after almost every event and can be found under the Recaps tab. These provide fans with a detailed description of what went on during that event along with any final results.

Knight of the Week: Each week the athletic department recognizes a few exceptional athletes for their hardwork and their stories can be found under this tab.

Practice Info

The "Practice Info" tab displays information about the times and locations of sports practices for the current week. During the fall season, this is often used to assign teams to certain fields, whereas in the winter when nearly everyone uses the gym, this is used to communicate when teams will be having their practices.

Athletics Channel

The Athletics Channel is where you will be able to find our live stream as well as some on-demand content. When we go live during an event, the app will automatically load the stream for you. Simply tap the "Watch" button and you're good to go. If we are off the air or you'd like to look through our on-demand content, tap the "Previous Events" button. Once you begin watching on supported devices, you may also have the ability to use Picture-in-Picture (PiP) mode, meaning that you can watch the stream and use other apps all at the same time. For those who would like to know when we go live, we offer On-Air Notifications. To enable these alerts, tap the bell icon in the navigation bar.

News Feed

The News Feed tab is where you will find all of the athletics related news articles from Marianapolis. There is also a Notifications tab where you can view push notifications you have interacted with in the past.

Settings and Support

The Settings and Support sections can be accessed from the Main Menu and offer exactly what you would expect. In the Settings section you can change your MyAthlete preferences as well as reset the app to its initial condition. In the Support section you can find the Privacy Policy as well as ways to contact us or provide feedback about your experience with the app. Your feedback is critical to the continued development of our software and anything you send us will be greatly appreciated.

MyAthlete

MyTeam

To get started using MyAthlete you must first select your team. If you haven't done this yet, you can do it in the Settings. If you opted into receiving push notifications when opening the app for the first time, upon selecting a team you will be subscribed to that team's notification channel automatically. This means that you may receive announcements from your coaches and captains via push notifications.

Once you have a team selected, the "My Team" tab will become active. This tab brings your team's information front and center and displays it in a simple, clean interface. On the Home tab you can see your team's record, next event, next uniform pickup time, and any announcements your coaches may have posted. Additionally, if you have multiple teams set up, you can switch between them using the user icon in the navigation bar.

There are also two other tabs in the My Team section: Events and Social. The Events tab contains a list of all the events in the current month and you can learn more about each one by tapping on it. If your team has a Twitter profile, its feed will be presented in the Social tab. If "Team Twitter Updates" is turned off, it can be enabled in the Settings.

MySchedule

MySchedule is your own interactive schedule based on your selected team. If you haven't yet, you can enable this feature in the app Settings.

Automatic Reminders

By selecting an event in the schedule and tapping the calendar icon in the navigation bar, you can set a reminder to go off 2 hours before the event starts. But this can be tedious if you want reminders for all of your events. Plus, the reminders won't be updated if something happens to change. That's where the "Automatic Game Reminders" feature comes in. This can be enabled in the Settings (under My Schedule) and allows your schedule to automatically generate reminders for all of your events instantly and updates them when there are any changes to your schedule. Notifications will be delivered 24 hours before the event and come with a snooze function.

Calendar Sync

MySchedule gives you the ability to sync your team's schedule with the Calendar app. Simply open the schedule from the Main Menu and tap the Calendar icon in the menu bar. Then select "Sync with Calendar". Once complete, your team's schedule will continue to be updated automatically and if iCloud is enabled, can be shared across all of your devices.

Multiple Teams

The MyAthlete feature can support up to three teams. Maybe you are a three-season athlete or you want to keep track of multiple teams at once, but no matter what the reason, it can all be done seamlessly. In the Settings section, you can tap either "My Teams" in the navigation bar, or "Multiple Teams" in the MyAthlete settings. This will take you to a pane where you can enable the feature and add, remove, or rename teams as desired. Additionally, if your device supports Touch ID, you can use it to prevent switching teams without authorization. This feature is designed primarily for situations when the app is being put on display and serves little purpose in general use.

Extensions

3D Touch

On devices supporting 3D Touch, users can launch a few pre-defined views using Home Screen Quick Actions. Simply apply a little pressure to the app icon with your finger to view all the available shortcuts. The following shortcuts are included:

• Upcoming
• Scores
• Live
• My Team

Upcoming Events Widget

The Upcoming Events Widget is included with every copy of the app. It is a simple widget that lives in your device's Notification Center and displays a list of upcoming athletic events. By default the widget is hidden and can be activated by opening your device's Today View and scrolling down to the bottom where there is an Edit button. In the resulting pane add the "Upcoming" widget and tap Done.

Advanced

Development Mode Developer use only

Development mode allows developers to test certain features and services in the background without affecting end-users. Once enabled, the device is subscribed to a special push notification channel designated for testing purposes. Development mode can be enabled on approved devices by signing into the Developer Console and using the configuration tools.

Elevated Permissions Authentication required

Advanced users can access the Control Console directly from the app's Main Menu. To enable this shortcut, the user must first sign into the Control Console and use the configuration tools to elevate their permissions. Authentication is required when using the console and additional Terms and Conditions apply.

The Marianapolis Athletics app control console is a web-based utility designed for members of the athletic department, coaches, and system administrators. The console provides tools for configuring the backend system and updating the app's content.

Included Tools

• Push Notifications
• MyAthlete Announcements
• Third-party services

Verified users also have access to:

Push Notifications

Push notifications can be sent to end-users through the Apple Push Notification Service (APNS) by using this tool. Users who have decided to allow push notifications will see a banner appear on their device with the message content and in some cases the badge app icon will display the number 1.

Topics and Subscriptions

Topics are channels designated for a specific group of users. For example, every sports team currently recognized by the app has their own topic. This means that notifications will only be sent to the users on that team and no one else.

All end-users are automatically subscribed to the "all-users" topic. Additionally, MyAthlete users will be subscribed to their team's individual topic. Any additional topics, such as On-Air Notifications for the Athletics Channel, must be set up manually.

Notification Payload

All notifications must include a body and it is recommended that you include a title. Additional parameters may also be provided as long as they conform to the following guidelines.

Message Required

The notification body is limited to 140 characters in length. This must always be provided in English and should not contain typos.

Title Optional

If included, the notification title cannot exceed 50 characters in length. The title should be kept short yet descriptive. Note that in some situations the title might not be displayed at all, so do not include critical information in the title.

Action Type Optional

This can be set using the type key. In the console use the input labeled "Action". If included, the key must match one of the options listed below. Note that these are case sensitive.

Web Content Optional

The webContent key must be set if the action type is set to "web" (see above). In the console this can be done by pasting a link into the field labeled "URL". This parameter only accepts valid URLs so be sure to include everything - even the protocol!

Payload Structure (APNS)

If you have a valid APNS Sandbox or Production certificate for this app and you are looking to send notifications to the app manually, the payload should be structured accordingly.

// JSON

payload = {

	type: 'web', // Action Type

	webContent: 'https://www.example.com', // Web Content - if applicable

	aps = {

		alert = {

			body: 'Wow. What a great day to go out and play some frisbee!',

			title: 'Hello world'

		},

		sound: 'default'
	}

}
				

Team Announcements

The announcements tool is part of the MyAthlete Controls. You can use this tool to change the message displayed on the homepage in the My Team section of the mobile app.

Announcements

Only one announcement can be displayed at a time (per team) meaning that new announcements will replace the current one. Announcements are limited to 140 characters and must be related to the team's activities. Additionally, the Marianapolis Common Language Policy (CLP) requires that all announcements be in English.

If you ever need to clear all messages from your team's dashboard, that functionality is also available.

Uniform Scheduling Requires verification

There are two tools available to help with scheduling uniform pickup times. Both of these tools are only available to approved admin-level users and their email address must have already been verified (this is typically done after signing up for an account). These tools are part of the MyAthlete Controls. The uniform pickup times are displayed on the homepage of the My Team section of the mobile app.

Uniform Schedule

The uniform schedule shows all of the entries currently in the database. By clicking on one of these entries, you can adjust the date and time of pickup for that specific team. You also have the option to delete the entry if no future pickups are to be scheduled. When updating the date and/or time, it is important to note the format. The format must comply with the guidelines below in order to be processed correctly.

Uni-Scheduler

The Uni-Scheduler can be used to add new entries to the database or to update existing ones. First select the team and enter the date and time of the next uniform pickup. Please be sure to note the format requirements which are outlined above. Once you hit "Submit", any existing entries for that team will be replaced with the new one, as the database only keeps track of one entry per team at any given time.

URL Scheme

The Marianapolis Athletics App takes advantage of our QuickLaunch API which allows developers to create specialized smart links. When a user taps on one of these links, they are taken directly to the specified content within the app itself. The API uses a unique URL scheme to accomplish this and you can learn more about how to use that below. You may also choose to link your application or website to our pre-configured redirect pages which handle using the API for you.

Last updated: March 21, 2018

Unless otherwise stated, any code samples on this site are licensed under the Apache 2.0 license.